Navigation

mongocli ops-manager process describe

The process describe command retrieves details about the specified MongoDB process in an Ops Manager project. You can also retrieve details about a process through the Ops Manager API.

mongocli ops-manager|om process describe|d <process-id>
[ --output|-o <output-format> ]
[ --profile|-P <profile-name> ]
[ --projectId <project-ID> ]
Note

Use -h or --help to view the command-line help for this command.

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
<process-id>
string

Unique identifier of the process you want to describe.

You can retrieve a list of processes for a project with the mongocli command process list.

yes
--profile, -P
string
Name of the profile where the public and private keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.
no
--projectId
string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

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
Type
Description
aliases
array of strings
Array of alternate hostname and port combinations that Ops Manager discovered for the process. These combinations can include hostnames, FQDN s, IPv4 addresses, and IPv6 addresses.
authMechanism
string

Authentication mechanism used to connect to this process. This displays one of the following values:

  • SCRAM_SHA_1
  • GSSAPI
  • PLAIN
  • MONGODB_X509
  • NONE
clusterId
string
ID of the cluster that owns this process.
created
string
Timestamp in ISO 8601 date and time format in UTC when this process was created or first discovered by Ops Manager.
groupId
string
ID of the project that owns this process.
hostname
string
Hostname of the machine running this process.
id
string
ID of this process.
ipAddress
string
IPv4 or IPv6 address associated with the hostname of this process. Additional accessible IPv4 or IPv6 addresses may be displayed in the aliases array.
lastPing
string
Timestamp in ISO 8601 date and time format in UTC when the last ping for this process was received.
lastRestart
string
Timestamp in ISO 8601 date and time format in UTC when this process last restarted. Omitted if this process has never been restarted.
replicaSetName
string
Name of the replica set </reference/glossary/#term-replica-set to which this process belongs. Only present if this process is part of a replica set.
replicaStateName
string
Current state of this process within a replica set. Only present if this process is part of a replica set. See Replica Set Member States for possible values.
shardName
string
Name of the shard to which this process belongs. Only present if the process is part of a sharded cluster.
typeName
string

Type of process. Possible values are:

  • REPLICA_PRIMARY
  • REPLICA_SECONDARY
  • RECOVERING
  • SHARD_MONGOS
  • SHARD_CONFIG
  • SHARD_STANDALONE
  • SHARD_PRIMARY
  • SHARD_SECONDARY
  • NO_DATA

The type for new processes is NO_DATA until deployment of the process is complete.

version
string
Version of MongoDB running for this process.
deactivated
boolean
true if this process is deactivated; false if this process is running.
hasStartupWarnings
boolean
true if this process has startup warnings.
hidden
boolean
true if host is displayed in the Ops Manager UI. Processes set to true are omitted from the response.
hiddenSecondary
boolean
true if this host is a hidden secondary.
hostEnabled
boolean
true if this process is currently enabled.
journalingEnabled
boolean
true if journaling is enabled for this process.
lowULimit
boolean
true if this process’s host has a low ulimit setting.
logsEnabled
boolean
true if Ops Manager is collecting logs for this process.
alertsEnabled
boolean
true if this process has alerts enabled.
profilerEnabled
boolean
true if Ops Manager collects profile information from this process.
sslEnabled
boolean
true if TLS or SSL is enabled for this process.
lastDataSizeBytes
number
Uncompressed size of the host’s databases on disk in bytes excluding indexes. lastDataSizeBytes does not include the data in the local database.
lastIndexSizeBytes
number
Uncompressed size of the host’s database indexes on disk in bytes. This number does not include the size of the index for the local database.
port
number
Port on which this process listens.
slaveDelaySec
number
Number of seconds this replica set member’s data trails the primary. If this value is set to 0, the member is not configured as a delayed member. For additional details on slave delays, see Delayed Replica Set Members.
uptimeMsec
number
Number of milliseconds since this process last restarted.
links
array of objects``
Array that includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. At minimum, a links array contains one link called self.

The following example uses the mongocli ops-manager describe command to describe the PRIMARY member in an Ops Manager deployment replica set. It uses the default profile where the API access keys and the project ID are stored.

mongocli ops-manager process describe 0ea97615dd78fd94f2b6cfc732af30ce --output json

The previous command prints the following fields in the specified format to the terminal. To learn more about these fields, see Output.

{
"aliases": [
"10.1.0.28:27017",
"repl-1:27017"
],
"authMechanismName": "NONE",
"clusterId": "5e300711eb1a6eb7b6ac07e2",
"created": "2020-05-15T15:39:34Z",
"groupId": "79300711e07705eac1a63beb",
"hostname": "repl-1.repl-svc.mongodb.svc.cluster.local",
"id": "6cfc73dd78fd932afea04f2b976150ce",
"ipAddress": "10.1.0.28",
"lastPing": "2020-05-15T17:36:55Z",
"replicaSetName": "repl",
"replicaStateName": "PRIMARY",
"typeName": "REPLICA_PRIMARY",
"version": "4.0.6",
"hasStartupWarnings": true,
"hostEnabled": true,
"journalingEnabled": true,
"logsEnabled": false,
"alertsEnabled": true,
"profilerEnabled": false,
"sslEnabled": false,
"port": 27017,
"uptimeMsec": 7022,
"links": [
{
"rel": "self",
"href": "http://om-svc.mongodb.svc.cluster.local:8080/api/public/v1.0/groups/79300711e07705eac1a63beb/hosts/6cfc73dd78fd932afea04f2b976150ce"
},
{
"rel": "http://mms.mongodb.com/cluster",
"href": "http://om-svc.mongodb.svc.cluster.local:8080/api/public/v1.0/groups/79300711e07705eac1a63beb/clusters/5ebeb7b6ac1a6300711e07e2"
},
{
"rel": "http://mms.mongodb.com/group",
"href": "http://om-svc.mongodb.svc.cluster.local:8080/api/public/v1.0/groups/79300711e07705eac1a63beb"
},
{
"rel": "http://mms.mongodb.com/metrics",
"href": "http://om-svc.mongodb.svc.cluster.local:8080/api/public/v1.0/groups/79300711e07705eac1a63beb/hosts/6cfc73dd78fd932afea04f2b976150ce/metrics"
},
{
"rel": "http://mms.mongodb.com/measurements",
"href": "http://om-svc.mongodb.svc.cluster.local:8080/api/public/v1.0/groups/79300711e07705eac1a63beb/hosts/6cfc73dd78fd932afea04f2b976150ce/measurements?granularity=PT5M\u0026period=PT24H"
}
]
}
Give Feedback