mongocli config describe
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 config describe command retrieves details about the
specified profile from the MongoDB CLI Configuration File.
Tip
See also:
Syntax
mongocli config describe <profile-name>
Arguments
Argument | Type | Description | Required? |
|---|---|---|---|
<profile-name> | string | Name of the profile to retrieve. Specify default to
retrieve the default profile. | yes |
Output
The command output looks similar to the following if the command succeeds. If the command prints errors, see Troubleshooting for recommended solutions.
public_api_key = redacted service = <service-name> ops_manager_ca_certificate = /etc/ssl/certs/ca.pem ops_manager_skip_verify = no ops_manager_url = <OM-URL> private_api_key = redacted project_id = <project-ID>
Note
The Programmatic API Keys are redacted for security purposes.
Example
The following example uses the mongocli config describe command
to retrieve a profile named egOmProfile from the configuration file.
mongocli config describe egOmProfile
The preceding command prints the following output to the terminal:
public_api_key = redacted service = ops-manager ops_manager_ca_certificate = /etc/ssl/certs/ca.pem ops_manager_skip_verify = no ops_manager_url = http://localhost:30700 private_api_key = redacted project_id = 5e84b2edf949e9007a7beac3