mongocli ops-manager admin backup filesystem list

On this page

Syntax

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 list command retrieves the configurations of all file system stores. You can also retrieve the configurations of all file system stores using the API.

Syntax

mongocli ops-manager admin backup |om filesystem|fileSystem list
     [ --limit <items-per-page> ]
     [ --page <page-number> ]
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]

Options

Option	Type	Description	Required?
`--limit`	integer	Number of items to return per page, up to a maximum of 500. Defaults to `100` if not specified.	no
`--page`	integer	Page number (1-based). Defaults to `1` if not specified.	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 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             WIREDTIGER   MMAPV1
<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 list command retrieves the configurations of all file systems using the default profile, which contains Ops Manager credentials.

mongocli om admin backup filesystem list

The previous command returns the following:

ID     PATH   WIREDTIGER   MMAPV1
test   /      NONE         GZIP

mongocli om admin backup filesystem list --output json

The previous command returns the following:

{
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:8080/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pageNum=1\u0026itemsPerPage=100"
    }
  ],
  "results": [
    {
      "id": "test",
      "loadFactor": 1,
      "mmapv1CompressionSetting": "GZIP",
      "storePath": "/",
      "wtCompressionSetting": "NONE",
      "assignmentEnabled": true
    }
  ],
  "totalCount": 1
}

Back

File System Store Configurations

Get One File System Store Configuration