mongocli ops-manager admin backup filesystem describe

On this page

Syntax

Arguments
Options
Output
Example

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 filesystem describe command retrieves the configuration of the specified file system store. You can also retrieve the configuration of a file system store using the API.

Syntax

mongocli ops-manager|om admin backup filesystem|fileSystem describe|get <file-system-config-ID>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]

Arguments

Option	Type	Description	Required?
`file-system-config-ID`	string	Unique name of the file system store configuration.	yes

Options

Option	Type	Description	Required?
`--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 accessing Ops Manager are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.	no

Output

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

ID                 PATH             WT COMPRESSION   MMAPV1 COMPRESSION
<file-system-ID>   <store-path>     NONE|GZIP        NONE|GZIP

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.

Example

The following mongocli om admin backup filesystem describe command retrieves the configuration of the file system store whose ID is test. The command uses the default profile to access Ops Manager.

mongocli om admin backup filesystem describe test

The previous command returns the following:

ID     PATH   WT COMPRESSION   MMAPV1 COMPRESSION
test   /      NONE             GZIP

mongocli om admin backup filesystem describe test --output json

The previous command returns the following:

{
  "id": "test",
  "loadFactor": 1,
  "mmapv1CompressionSetting": "GZIP",
  "storePath": "/",
  "wtCompressionSetting": "NONE",
  "assignmentEnabled": true
}

Back

Get All File System Store Configurations

Update One File System Store Configuration