Navigation

mongocli cloud-manager backup snapshots schedule describe

The backup snapshots schedule describe command retrieves the backup snapshot schedule for the specified cluster. You can also view the backup snapshot schedule through the Cloud Manager UI or API.

mongocli cloud-manager|cm backup(s) snapshot(s) schedule describe|get
--clusterId <cluster-id>
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
[ --projectId <project-ID> ]
Note

Use -h or --help to view the command-line help for this command.

Option
Type
Description
Required?
--clusterId
string
Unique identifier of the cluster for which you want to retrieve its backup snapshot schedule.
yes
--output, -o
string

Command output format. Valid values are:

  • json for output in JSON format
  • go-template for custom output using the Go template
  • go-template-file for custom output specified using the Go template file

If omitted, the command returns output in the default format.

no
--profile, -P
string
Name of the profile where the project ID and the Programmatic API Keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no
--projectId
string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

no

The command prints the following fields in the specified format to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.

PROJECT ID CLUSTER ID MONTHLY SNAPSHOT RETENTION MONTHS POINT IN TIME WINDOW HOURS
5f1f39ffc902201990f53873 5f457bd5c90220199051210c 1 24

The default output is a subset of the fields returned by this command. For the complete list of JSON fields returned by the command, see the Public API reference for your MongoDB service:

The following command retrieves the backup snapshot schedule for the specified cluster. The command uses the default profile, which contains Cloud Manager credentials. The MongoDB CLI returns the output in the default format.

mongocli cm backup snapshot schedule describe \
--clusterId 5f457bd5c90220199051210c

The previous command prints the following to the terminal.

PROJECT ID CLUSTER ID MONTHLY SNAPSHOT RETENTION MONTHS POINT IN TIME WINDOW HOURS
5f1f39ffc902201990f53873 5f457bd5c90220199051210c 1 24
Give Feedback