Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli ops-manager backups restores start

On this page

  • Syntax
  • Options
  • Inherited Options

Start a restore job for a project and cluster.

mongocli ops-manager backups restores start <AUTOMATED_RESTORE|HTTP> [options]
Name
Type
Required
Description
--checkpointId
string
false
Unique identifier for the sharded cluster checkpoint that represents the point in time to which your data will be restored. If you set checkpointId, you cannot set oplogInc, oplogTs, snapshotId, or pointInTimeUTCMillis.
--clusterId
string
true
Unique identifier of the cluster.
--expirationHours
int
false
Number of hours the download URL is valid once the restore job is complete. For use only with download restore jobs.
--expires
string
false
Timestamp in ISO 8601 date and time format after which the URL is no longer available. For use only with download restore jobs.
-h, --help
false
help for start
--maxDownloads
int
false
Number of times the download URL can be used. This must be 1 or greater. For use only with download restore jobs.
--oplogInc
int
false
32-bit incrementing ordinal that represents operations within a given second. When paired with oplogTs, they represent the point in time to which your data will be restored.
--oplogTs
string
false
Oplog timestamp given as a timestamp in the number of seconds that have elapsed since the UNIX epoch. When paired with oplogInc, they represent the point in time to which your data will be restored.
-o, --output
string
false
Output format. Valid values: json|json-path|go-template|go-template-file
--pointInTimeUTCMillis
float
false
Timestamp in the number of milliseconds that have elapsed since the UNIX epoch that represents the point in time to which your data will be restored. This timestamp must be within last 24 hours of the current time.
--projectId
string
false
Project ID to use. Overrides configuration file or environment variable settings.
--snapshotId
string
false
Unique identifier of the snapshot to restore.
--targetClusterId
string
false
Unique identifier of the target cluster. For use only with automated restore jobs.
--targetProjectId
string
false
Unique identifier of the project that contains the destination cluster for the restore job.
Name
Type
Required
Description
-P, --profile
string
false
Profile to use from your configuration file.

Auto generated by cobra2snooty on 13-Jul-2021

←  mongocli ops-manager backups restores listmongocli ops-manager backups snapshots →
Share Feedback