Navigation

mongocli ops-manager admin backup s3 describe

Note

You must be a Global Owner to run admin commands.

The admin backup s3 describe command retrieves configuration information for the specified backup S3 blockstore configuration. You can also retrieve an S3 configuration using the API, or view S3 configurations in the Administration Console.

mongocli ops-manager|om admin backup s3 describe|get <s3-name>
[ --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?
<s3-name>
string
Unique identifier of the S3 blockstore configuration that you want to describe. You can retrieve a list of S3 names for a deployment with the List Backup S3 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 accessing Ops Manager 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.

NAME URI SSL LOAD FACTOR AUTH METHOD
<name> <hostname>:<port> <boolean> <integer> <s3-auth-method>

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 an S3 blockstore using the default profile, which contains Global Owner Ops Manager credentials. The output is returned in the default format.

mongocli ops-manager admin backup s3 describe s3BackupExample

The previous command prints the following to the terminal.

NAME URI SSL LOAD FACTOR AUTH METHOD
s3BackupExample mongodb://127.0.0.1:27017 false 1
Give Feedback