Skip to content

Commit 8b894c9

Browse files
Anthony Sansoneatsansone
authored andcommitted
(DOCSP-13227) Update typeName list for process list
1 parent 28c3b3f commit 8b894c9

File tree

2 files changed

+44
-44
lines changed

2 files changed

+44
-44
lines changed
Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
.. list-table::
22
:header-rows: 1
33
:widths: 20 10 70
4-
4+
55
* - Name
66
- Type
77
- Description
8-
8+
99
* - ``created``
1010
- DateTime
1111
- Date this MongoDB process was created.
12-
12+
1313
* - ``groupId``
1414
- string
1515
- ID of the project that owns the process.
16-
16+
1717
* - ``hostname``
1818
- string
1919
- Hostname of the machine running the process.
20-
20+
2121
* - ``id``
2222
- string
2323
- Host ID of the machine running the process.
24-
24+
2525
* - ``lastPing``
2626
- DateTime
2727
- Date and time when the last ping for this process was received.
28-
28+
2929
* - ``links``
3030
- array of objects
3131
- One or more links to sub-resources and/or related resources.
@@ -36,31 +36,30 @@
3636

3737
* - ``shardName``
3838
- string
39-
- Name of the shard this process belongs to. Only present if
39+
- Name of the shard this process belongs to. Only present if
4040
this process is part of a sharded cluster.
4141

4242
* - ``replicaSetName``
4343
- string
44-
- Name of the replica set this process belongs to. Only present if
45-
this process is part of a replica set.
46-
44+
- Name of the replica set this process belongs to. Only present
45+
if this process is part of a replica set.
46+
4747
* - ``typeName``
4848
- string
4949
- Type of process. Possible values are:
50-
50+
51+
- ``NO_DATA``
52+
- ``RECOVERING``
53+
- ``REPLICA_ARBITER``
5154
- ``REPLICA_PRIMARY``
5255
- ``REPLICA_SECONDARY``
53-
- ``RECOVERING``
56+
- ``SHARD_CONFIG_PRIMARY``
57+
- ``SHARD_CONFIG_SECONDARY``
5458
- ``SHARD_MONGOS``
55-
- ``SHARD_CONFIG``
56-
- ``SHARD_STANDALONE``
57-
- ``SHARD_PRIMARY``
58-
- ``SHARD_SECONDARY``
59-
- ``NO_DATA``
6059

61-
The type for new processes is ``NO_DATA`` until deployment of the
62-
process is complete.
63-
60+
The type for new processes is ``NO_DATA`` until process
61+
deployment completes.
62+
6463
* - ``version``
6564
- string
6665
- Version of MongoDB running for this process.

source/reference/ops-manager/process-list.txt

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,12 @@ mongocli ops-manager process list
1515
.. include:: /includes/styles/corrections.rst
1616

1717
The ``process list`` command retrieves information about all running
18-
:manual:`mongod </reference/program/mongod/#bin.mongod>` and
19-
:manual:`mongos </reference/program/mongos/#bin.mongos>` processes for a
20-
given |mms| project.
18+
|mongod| and |mongos| processes for a given |mms| project.
2119

22-
Syntax
20+
Syntax
2321
------
2422

25-
.. code-block:: text
23+
.. code-block:: shell
2624

2725
mongocli ops-manager|om process list|ls
2826
[ --output|-o <output-format> ]
@@ -31,41 +29,44 @@ Syntax
3129

3230
.. include:: /includes/fact-command-line-help.rst
3331

34-
Options
32+
Options
3533
-------
3634

3735
.. list-table::
3836
:header-rows: 1
3937
:widths: 20 10 60 10
4038

41-
* - Option
42-
- Type
43-
- Description
44-
- Required?
39+
* - Option
40+
- Type
41+
- Description
42+
- Required?
4543

4644
* - ``--output``, ``-o``
47-
- string
45+
- string
4846
- .. include:: /includes/extracts/fact-basic-options-output.rst
4947
- no
5048

5149
* - ``--profile``, ``-P``
5250
- string
53-
- Name of the profile where the project ID and the |svc-api-key|\s
54-
for the project are saved. If omitted, uses the {+default-profile+}.
55-
To learn more about creating a profile, see :ref:`mcli-configure`.
51+
- Name of the profile where the project ID and the |svc-api-key|\s
52+
for the project are saved. If omitted, uses the
53+
{+default-profile+}.
54+
55+
To learn more about creating a profile, see
56+
:ref:`mcli-configure`.
5657
- no
5758

5859
* - ``--projectId``
5960
- string
60-
- Unique identifier of the project that contains the cluster.
61-
If omitted, uses the project ID in the profile or :ref:`environment
62-
variable <mcli-env-var>`.
61+
- Unique identifier of the project that contains the cluster. If
62+
omitted, uses the project ID in the profile or
63+
:ref:`environment variable <mcli-env-var>`.
6364
- no
6465

6566
.. _mcli-om-process-list-output:
6667

67-
Output
68-
------
68+
Output
69+
------
6970

7071
.. include:: /includes/command-output-intro.rst
7172

@@ -77,10 +78,10 @@ MongoDB process within your |mms| project.
7778
Example
7879
-------
7980

80-
The following example uses the ``mongocli ops-manager process list`` command
81-
to retrieve information about MongoDB processes running on the project.
82-
The command uses the {+default-profile+} where the project ID and the
83-
|svc-api-key|\s are stored.
81+
The following example uses the ``mongocli ops-manager process list``
82+
command to retrieve information about MongoDB processes running on the
83+
project. The command uses the {+default-profile+} where the project ID
84+
and the |svc-api-key|\s are stored.
8485

8586
.. code-block:: json
8687

0 commit comments

Comments
 (0)