Navigation

mongocli ops-manager admin backup filesystem describe

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.

mongocli ops-manager|om admin backup filesystem|fileSystem describe|get <file-system-config-ID>
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
Option
Type
Description
Required?
file-system-config-ID
string
Unique name of the file system store configuration.
yes
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 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 accessing Ops Manager are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no

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.

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
Give Feedback