mongocli ops-manager backup config 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.

The backup config describe command retrieves the backup configuration details for the specified cluster. You can also retrieve the backup configuration details for a cluster using the API.

Syntax

mongocli ops-manager|om backup config describe|get <cluster-ID>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Arguments

Argument	Type	Description	Required?
`<cluser-ID>`	string	Unique identifier of the cluster whose backup configuration you want to retrieve. You can use the mongocli ops-manager cluster list to retrieve the ID of a cluster.	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 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

Output

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.

Example

The following example uses the mongocli ops-manager backup config describe command to retrieve the backup configuration details for the specified cluster. The command uses the default profile to access the project.

mongocli ops-manager backup config describe 5fabae1d98bd2e1eddb875b3

The previous command returns the following:

PROJECT ID                 CLUSTER ID                 STATUS     STORAGE ENGINE
5faba4b381b378146d110f67   5fabae1d98bd2e1eddb875b3   STARTED    WIRED_TIGER

mongocli ops-manager backup config describe 5fabae1d98bd2e1eddb875b3 --output json

The previous command returns the following:

{
  "groupId": "5faba4b381b378146d110f67",
  "clusterId": "5fabae1d98bd2e1eddb875b3",
  "statusName": "STARTED",
  "storageEngineName": "WIRED_TIGER",
  "authMechanismName": "NONE",
  "encryptionEnabled": false,
  "sslEnabled": false
}

Back

Update One Backup Configuration

Describe One Backup Snapshot Schedule