mongocli cloud-manager backup snapshots schedule update¶

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

Syntax¶

mongocli cloud-manager|cm backup(s) snapshot(s) schedule update
     [ --clusterCheckpointIntervalMin <checkpoint-interval-minutes> ]
     --clusterId <cluster-id>
     [ --dailySnapshotRetentionDays <retention-days> ]
     [ --monthlySnapshotRetentionMonths <retention-months> ]
     [ --output|-o <output-format> ]
     [ --pointInTimeWindowHours <pit-window-hours> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]
     [ --referenceHourOfDay <reference-hour-of-day> ]
     [ --referenceMinuteOfHour <reference-minute-of-hour> ]
     [ --referenceTimeZoneOffset <reference-timezone-offset> ]
     [ --snapshotIntervalHours <snapshot-interval-hours> ]
     [ --snapshotRetentionDays <snapshot-retention-days> ]
     [ --weeklySnapshotRetentionWeeks <weekly-snapshot-retention-weeks> ]

Note

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

Options¶

Option	Type	Description	Required?
`--clusterCheckpointIntervalMin`	integer	Minutes between successive cluster checkpoints. This number determines the granularity of point-in-time restores for sharded clusters. Cloud Manager accepts the following values: `15`, `30`, and `60`. Important `--clusterCheckpointIntervalMin` only applies to sharded clusters. You may use checkpoints for clusters that run MongoDB with `Feature Compatibility Version` of 4.0 or earlier. Checkpoints were removed from MongoDB instances with FCV of 4.2 or later.	no
`--clusterId`	string	Unique identifier of the cluster for which you want to update its backup snapshot schedule.	yes
`--dailySnapshotRetentionDays`	integer	Days to retain daily snapshots. Cloud Manager accepts values between `0` and `365`, inclusive. Note To disable daily snapshot retention, set `--dailySnapshotRetentionDays` to `0`.	no
`--monthlySnapshotRetentionMonths`	integer	Months to retain monthly snapshots. Cloud Manager accepts values between `0` and `36`, inclusive. Note To disable monthly snapshot retention, set `--monthlySnapshotRetentionMonths` to `0`.	no
`--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
`--pointInTimeWindowHours`	integer	Number of hours in the past for which users can create a point-in-time snapshot.	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
`--referenceHourOfDay`	integer	Hour of the day to schedule snapshots using a 24 hour clock. Cloud Manager accepts values between `0` and `23`, inclusive.	no
`--referenceMinuteOfHour`	integer	Minute of the hour to schedule snapshots. Cloud Manager accepts values between `0` and `59`, inclusive.	no
`--referenceTimeZoneOffset`	string	The ISO-8601 timezone offset where the Cloud Manager host resides. To avoid problems with daylight saving time, use UTC . The default is `+0000`, which is equivalent to UTC . `Z` is also a supported value and equivalent to UTC .	no
`--snapshotIntervalHours`	integer	Hours between snapshots. Cloud Manager accepts values of `6`, `8`, `12`, and `24`.	no
`--snapshotRetentionDays`	integer	Days to keep recent snapshots. Cloud Manager accepts values between `2` and `30`, inclusive.	no
`--weeklySnapshotRetentionWeeks`	integer	Weeks to retain weekly snapshots. Cloud Manager accepts values between `0` and `52`, inclusive. Note To disable weekly snapshot retention, set `--weeklySnapshotRetentionWeeks` to `0`.	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.

Snapshot schedule updated.

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:

Cloud Manager API

Examples¶

The following command updates 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 om backup snapshot schedule update \
    --clusterId 5f457bd5c90220199051210c \
    --SnapshotRetentionDays 2

The previous command prints the following to the terminal.

Snapshot schedule updated.

Give Feedback

← mongocli cloud-manager backup snapshots schedule describe Cloud Manager cluster Commands →