Docs Menu
Docs Home
/ /
MongoDB CLI
/ / / / /

mongocli cloud-manager backups snapshots schedule update

On this page

  • Syntax
  • Options
  • Inherited Options

Update a snapshot schedule for a cluster.

Command Syntax
mongocli cloud-manager backups snapshots schedule update [options]
Name
Type
Required
Description

--clusterCheckpointIntervalMin

int

false

Number of minutes between successive cluster checkpoints. Valid values are 15, 30, or 60.

--clusterId

string

true

Unique identifier of the cluster.

--dailySnapshotRetentionDays

int

false

Number of days to retain daily snapshots. Accepted values are between 1 and 365 inclusive.

-h, --help

false

help for update

--monthlySnapshotRetentionMonths

int

false

Number of months to retain monthly snapshots. Accepted values are between 1 and 36 inclusive.

-o, --output

string

false

Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.

--pointInTimeWindowHours

int

false

Number of hours in the past for which MongoDB should create a point-in-time snapshot.

--projectId

string

false

Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.

--referenceHourOfDay

int

false

Hour of the day to schedule snapshots using a 24-hour clock. Accepted values are between 0 and 23 inclusive.

--referenceMinuteOfHour

int

false

Minute of the hour to schedule snapshots. Accepted values are between 0 and 59 inclusive.

--referenceTimeZoneOffset

string

false

ISO-8601-formatted timezone offset where the Ops Manager host resides.

--snapshotIntervalHours

int

false

Number of hours between snapshots. Valid values are 6, 8, 12, or 24.

--snapshotRetentionDays

int

false

Number of days to keep recent snapshots. Accepted values are between 2 and 5 inclusive.

--weeklySnapshotRetentionWeeks

int

false

Number of weeks to retain weekly snapshots. Accepted values are between 1 and 52 inclusive.

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Back

describe