mongocli atlas processes describe
mongocli atlas commands are now deprecated and will be removed in a future release. To enjoy the same capabilities and the latest features, use the new, dedicated CLI for Atlas users. To learn more, see Migrate to the Atlas CLI.Return the details for the specified MongoDB process for your project.
Syntax
Command Syntax
mongocli atlas processes describe <hostname:port> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
hostname:port | string | true | Hostname and port number of the instance running the Atlas MongoDB process. |
Options
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 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. |
Inherited Options
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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID REPLICA SET NAME SHARD NAME VERSION <Id> <ReplicaSetName> <ShardName> <Version>
Examples
# Return the JSON-formatted details for the MongoDB process with hostname and port atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 mongocli atlas process describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json