Docs Menu
Docs Home
/
MongoDB Atlas
/
MongoDB Command Line Interface
/
Reference
/
Ops Manager
/
Backups

mongocli ops-manager backup snapshots schedule describe

On this page

  • Syntax
  • Options
  • Output
  • Examples

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 Ops Manager UI or API.

Syntax

mongocli ops-manager|om 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.

Options

Option
Type
Description
Required?
--clusterId
string
Unique identifier of the cluster for which you want to retrieve the 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 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

Output

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:

Examples

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

mongocli om 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

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

mongocli om backup snapshot schedule describe \
    --clusterId 5f457bd5c90220199051210c -o json

The previous command prints the following to the terminal in JSON format.

1{
2  "clusterId": "5f457bd5c90220199051210c",
3  "groupId": "5f1f39ffc902201990f53873",
4  "links": [
5    {
6      "rel": "self",
7      "href": "http://example.com:8080/api/public/v1.0/groups/5f1f39ffc902201990f53873/backupConfigs/5f457bd5c90220199051210c/snapshotSchedule"
8    },
9    {
10      "rel": "http://mms.mongodb.com/cluster",
11      "href": "http://example.com:8080/api/public/v1.0/groups/5f1f39ffc902201990f53873/clusters/5f457bd5c90220199051210c"
12    },
13    {
14      "rel": "http://mms.mongodb.com/backupConfig",
15      "href": "http://example.com:8080/api/public/v1.0/groups/5f1f39ffc902201990f53873/backupConfigs/5f457bd5c90220199051210c"
16    },
17    {
18      "rel": "http://mms.mongodb.com/group",
19      "href": "http://example.com:8080/api/public/v1.0/groups/5f1f39ffc902201990f53873"
20    }
21  ],
22  "monthlySnapshotRetentionMonths": 1,
23  "pointInTimeWindowHours": 24,
24  "snapshotIntervalHours": 24,
25  "snapshotRetentionDays": 2,
26  "weeklySnapshotRetentionWeeks": 2
27}

Back

Describe One Backup Configuration

Next

Update One Backup Snapshot Schedule