Navigation

mongocli ops-manager admin backup sync update

Note

You must be a Global Owner to run admin commands.

The admin backup sync update command updates one sync store configuration. You can also update a sync store configuration using the API

mongocli ops-manager|om admin backup sync update <name>
[ --assignment ]
[ --encryptedCredentials ]
[ --label <tags> ]
[ --loadFactor <number-of-backup-jobs> ]
[ --maxCapacityGB <amount-of-data> ]
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
[ --ssl ]
--uri <hosts>
[ --writeConcern <write-concern> ]
Option
Type
Description
Required?
name
string
Unique name for the sync store you want to update. This is also the sync store ID. You can retrieve a list of sync store names for a project with the List Backup Sync Store Configurations command.
yes
Option
Type
Description
Required?
--assignment
Flag that indicates whether this sync store can be assigned backup jobs.
no
--encryptedCredentials
Flag that indicates whether the username and password for this sync store were encrypted using the credentialstool.
no
--label
array of strings
Array of tags that specify which backup jobs Ops Manager can assign to which sync stores. If omitted, this sync store can only process the backup jobs for projects that don't use labels to filter their jobs.
no
--loadFactor
number
Required if more than one snapshot store is in use. Number that expresses how much backup work this snapshot store should perform compared to another snapshot store. Value must be a positive, non-zero integer.
no
--maxCapacityGB
number
Maximum amount of data in GB that this sync store can store.
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
--profile, -P
string
Name of the profile where the public and private 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
--ssl
Flag that indicates whether this sync store only accepts connections encrypted using TLS .
no
--uri
string
Comma-separated list of hosts in the <hostname:port> format to use to access this sync store.
yes
--writeConcern
string

Write concern to use for this sync store. Valid values are:

  • ACKNOWLEDGED
  • W2
  • JOURNALED
  • MAJORITY
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.

Sync configuration '<name>' updated.

The default output contains a subset of the fields returned by this command. For the complete list of JSON fields returned by the command, see the API reference.

The following mongocli om admin backup sync update command updates the test sync store. The command uses the default profile, which contains the credentials for accessing Ops Manager.

mongocli om admin backup sync update test --uri mongodb://localhost:27017

The previous command returns the following:

Sync configuration 'test' updated.
Give Feedback