mongocli ops-manager admin backup filesystem update
Note
You must be a Global Owner to run admin commands.
The admin backup filesystem update command updates one
backup file system store configuration. You can also update the
configuration using the UI
and the API.
Syntax
mongocli ops-manager|om admin backup filesystem|fileSystem update <file-system-ID> [ --assignment ] [ --encryptedCredentials ] [ --label <tags> ] [ --loadFactor <number-of-backup-jobs> ] [ --mmapv1CompressionSetting <NONE|GZIP> ] [ --output|-o <output-format> ] [ --profile|-P <profile-name> ] --storePath <path-to-backups> [ --wtCompressionSetting <NONE|GZIP> ]
Note
Use -h or --help to view the command-line help for
this command.
Arguments
Option | Type | Description | Required? |
|---|---|---|---|
<file-system-ID> | string | Unique name for this file system store configuration. | yes |
Options
Option | Type | Description | Required? |
|---|---|---|---|
--assignment | Flag that indicates whether this file system store can be assigned backup
jobs. | no | |
--encryptedCredentials | Flag that indicates whether the username and password for this
file system 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 file system store. If omitted, this
file system store 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 |
--mmapv1CompressionSetting | string | Compression setting if you use the MMAPv1 storage engine for your
snapshots. Ops Manager accepts If your snapshots don't use the MMAPv1 storage engine, this value
must be | yes |
--output, -o | string | Command output format. Valid values are:
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 |
--storePath | string | Location where file system-based backups are stored on the file
system store host. | yes |
--wtCompressionSetting | string | Compression setting if you use the WiredTiger storage engine for
your snapshots. Ops Manager accepts If your snapshots don't use the WiredTiger storage engine, this
value must be | yes |
Output
If the command succeeds, it returns the following message in the default format. If the command returns errors, see Troubleshooting for recommended solutions.
File System configuration '<file-system-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 filesystem update command
updates the test file system store using the default profile,
which contains the credentials for accessing Ops Manager.
mongocli om admin backup filesystem update test --assignment --storePath /data/backup --mmapv1CompressionSetting NONE --wtCompressionSetting GZIP
The previous command returns the following:
File System configuration 'test' updated.
mongocli om admin backup filesystem update test --assignment --storePath /data/backup --mmapv1CompressionSetting NONE --wtCompressionSetting GZIP --output json
The previous command returns the following:
{ "id" : "test", "assignmentEnabled" : true, "loadFactor" : 1, "mmapv1CompressionSetting" : "NONE", "storePath" : "/data/backup", "wtCompressionSetting" : "GZIP" }