Navigation

mongocli ops-manager backup config list

The backup config list command lists all the backup configurations for a project. You can also retrieve the backup configurations for a project using the API.

mongocli ops-manager|om backup config list|ls
[ --limit <items-per-page>]
[ --output|-o <output-format> ]
[ --page <page-num> ]
[ --profile|-P <profile-name> ]
[ --projectId <project-ID> ]
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
--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 project ID and the Programmatic API 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
--projectId
string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

no
--page
integer
Page number (1-based). Defaults to 1 if not specified.
no

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

PROJECT ID CLUSTER ID STATUS STORAGE ENGINE
<project-ID> <cluster-ID> <status> <storage-engine>

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 example uses the mongocli ops-manager backups config list command to retrieve the backup configurations for the project specified through the default profile.

mongocli ops-manager backups config list

The previous command returns the following:

PROJECT ID CLUSTER ID STATUS STORAGE ENGINE
5fa95889d765fe62f0aff52f 5fa958c2d765fe62f0aff5fc INACTIVE WIRED_TIGER
5faba4b381b378146d110f67 5fabae1d98bd2e1eddb875b3 STARTED WIRED_TIGER
Give Feedback