Docs Menu

Docs HomeAtlas CLI

atlas processes describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Return the details for the specified MongoDB process for your project.

Command Syntax
atlas processes describe <hostname:port> [options]
Name
Type
Required
Description
hostname:port
string
true
Hostname and port number of the instance running the Atlas MongoDB process.
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 the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

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>
# Return the JSON-formatted details for the MongoDB process with hostname and port atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017
atlas process describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json
←  atlas processesatlas processes list →