mongocli ops-manager admin backup blockstore update

On this page

Syntax

Arguments
Options
Output
Examples

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.

Note

You must be a Global Owner to run admin commands.

The admin backup blockstore update command updates one backup blockstore configuration. You can also update the configuration using the API.

Syntax

mongocli ops-manager|om admin backup blockstore update <blockstore-ID>
     [ --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> ]

Arguments

Option	Type	Description	Required?
`<blockstore-ID>`	string	Unique name for this blockstore configuration.	yes

Options

Option	Type	Description	Required?
`--assignment`		Flag that indicates whether this blockstore can be assigned backup jobs.	no
`--encryptedCredentials`		Flag that indicates whether the username and password for this blockstore were encrypted using the credentialstool.	no
`--label`	array of strings	Array of tags that specify which backup jobs Ops Manager can assign to which blockstores. If omitted, this blockstore can only process the backup jobs for projects that do not use labels to filter their jobs.	no
`--loadFactor`	number	Required if more than one snapshot store is in use. Number of 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 blockstore 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 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 blockstore only accepts connections encrypted using TLS.	no
`--uri`	string	Comma-separated list of hosts in the `<hostname:port>` format to use to access this blockstore.	no
`--writeConcern`	string	Write concern to use for this blockstore. Valid values are: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY`	no

Output

If the command succeeds, it returns the following message in the default format. If the command returns errors, see Troubleshooting for recommended solutions.

Blockstore configuration '<blockstore-ID>' updated.

If you request output in JSON format, the command returns the fields described in the API reference.

Examples

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

mongocli om admin backup blockstore update test --assignment  --uri mongodb://localhost:29022

The previous command returns the following:

Blockstore configuration 'test' updated.

mongocli om admin backup blockstore update test --assignment  --uri mongodb://localhost:29022 --output json

The previous command returns the following:

{
  "id": "test",
  "uri": "mongodb://localhost:29022",
  "ssl": false,
  "assignmentEnabled": true,
  "encryptedCredentials": false,
  "usedSize": 204800,
  "loadFactor": 1
}

Back

Describe a Backup Blockstore Configuration

Delete One Backup Blockstore Configuration