Navigation

mongocli ops-manager admin backup blockstore describe

Note

You must be a Global Owner to run admin commands.

The admin backup blockstore describe command retrieves configuration information for the specified backup blockstore.

mongocli ops-manager|om admin backup blockstore describe|get <blockstore-id>
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
Note

Use -h or --help to view the command-line help for this command.

Argument
Type
Description
Required?
<blockstore-id>
string
Unique identifier of the blockstore that you want to describe. You can retrieve a list of blockstore IDs for a project with the List Backup Blockstore Configurations command.
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 the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no

The command prints the following fields in the specified format to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.

ID URI SSL LOAD FACTOR
<id> <hostname>:<port> <boolean> <integer>

The default output is a subset of the fields returned by this command. For the complete list of JSON fields returned by the command, see the Public API reference for your MongoDB service:

The following command retrieves configuration information for a backup blockstore using the default profile, which contains Ops Manager credentials. The output is returned in the default format.

mongocli ops-manager admin backup blockstore describe blockstore

The previous command prints the following to the terminal.

ID URI SSL LOAD FACTOR
blockstore mongodb://cluster-example.mongodb.net:27017 false 1
Give Feedback