Docs Menu

Docs HomeMongoDB CLI

mongocli ops-manager clusters describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options

Describe a cluster.

When describing cluster with no output format please provide the cluster ID. When using an output format please provide the cluster name.

Command Syntax
mongocli ops-manager clusters describe <id|name> [options]
Name
Type
Required
Description
id|name
string
true
Name or ID of the cluster.
Name
Type
Required
Description
-h, --help
false
help for describe
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.
←  mongocli ops-manager clusters deletemongocli ops-manager clusters indexes →