Skip to content

Commit c3735fe

Browse files
jwilliams-mongojwilliams-mongo
authored
(DOCSP-12700): mongocli om|cm monitoring stop (#336)
* (DOCSP-12700): mongocli om|cm monitoring stop * (DOCSP-12700): fix toc
1 parent 78a130d commit c3735fe

File tree

6 files changed

+288
-1
lines changed

6 files changed

+288
-1
lines changed

‎source/reference/cloud-manager.txt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ Cloud Manager ``mongocli`` Commands
3636
:ref:`metric <mcli-reference-cm-metric>`
3737
Lists metrics for MongoDB processes on a specified host.
3838

39+
:ref:`monitoring <mcli-reference-cm-monitoring>`
40+
Manage Monitoring for a specified host.
41+
3942
:ref:`performanceAdvisor <mcli-reference-cm-performanceadvisor>`
4043
Retrieve information generated by the
4144
:cloudmgr:`Performance Advisor </tutorial/performance-advisor/>`
@@ -54,7 +57,6 @@ Cloud Manager ``mongocli`` Commands
5457
Retrieves all hosts that are running an Automation Agent in the
5558
specified |cloud-short| project.
5659

57-
5860
.. toctree::
5961
:titlesonly:
6062

@@ -67,6 +69,7 @@ Cloud Manager ``mongocli`` Commands
6769
Events </reference/cloud-manager/event-commands>
6870
Maintenance Window </reference/cloud-manager/maintenanceWindow-commands>
6971
Metrics </reference/cloud-manager/metric-commands>
72+
Monitoring </reference/cloud-manager/monitoring-commands>
7073
Performance Advisor </reference/cloud-manager/performanceadvisor-commands>
7174
Processes </reference/cloud-manager/process-commands>
7275
Security </reference/cloud-manager/security-commands>

‎source/reference/cloud-manager/monitoring-commands.txt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _mcli-reference-cm-monitoring:
2+
3+
=====================================
4+
Cloud Manager ``monitoring`` Commands
5+
=====================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. toctree::
10+
:titlesonly:
11+
12+
Stop Monitoring One Host </reference/cloud-manager/monitoring-stop>

‎source/reference/cloud-manager/monitoring-stop.txt‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
.. _mcli-cm-monitoring-stop-command:
2+
3+
======================================
4+
mongocli cloud-manager monitoring stop
5+
======================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
The ``monitoring stop`` command stops the {+mdbagent+} from monitoring
16+
the host that you specify. You can also stop Monitoring for one host in
17+
|cloud-short| using the :cloudmgr:`UI
18+
</tutorial/mongodb-agent-functions/#deactivate-monitoring>` and
19+
:cloudmgr:`API </reference/api/hosts/delete-one-host/>`.
20+
21+
You must have :cloudmgr:`Project Monitoring Admin
22+
</reference/user-roles/#Project-Monitoring-Admin>` or :cloudmgr:`Project
23+
Owner </reference/user-roles/#Project-Owner>` role to stop the
24+
{+mdbagent+} from monitoring a host.
25+
26+
.. _mcli-cm-monitoring-stop-syntax:
27+
28+
Syntax
29+
------
30+
31+
.. code-block:: sh
32+
33+
mongocli cloud-manager|cm monitoring stop <hostId>
34+
[ --force ]
35+
[ --profile|-P <profile-name> ]
36+
[ --projectId <project-ID> ]
37+
38+
.. _mcli-cm-monitoring-stop-arguments:
39+
40+
Arguments
41+
---------
42+
43+
.. list-table::
44+
:header-rows: 1
45+
:widths: 20 10 60 10
46+
47+
* - Option
48+
- Type
49+
- Description
50+
- Required?
51+
52+
* - ``<hostId>``
53+
- string
54+
- Unique identifier of the host you want to stop monitoring.
55+
56+
Use the :ref:`mcli-cm-process-list-cmd` command to retrieve
57+
unique identifiers for your hosts.
58+
59+
- yes
60+
61+
.. _mcli-cm-monitoring-stop-options:
62+
63+
Options
64+
-------
65+
.. list-table::
66+
:header-rows: 1
67+
:widths: 20 10 60 10
68+
69+
* - Option
70+
- Type
71+
- Description
72+
- Required?
73+
74+
* - ``--force``
75+
-
76+
- Bypasses the confirmation prompt.
77+
- no
78+
79+
* - ``--profile``, ``-P``
80+
- string
81+
- Name of the profile where the public and private
82+
keys for the project are saved. If omitted, uses the
83+
{+default-profile+}. To learn more about creating a
84+
profile, see :ref:`mcli-configure`.
85+
- no
86+
87+
* - ``--projectId``
88+
- string
89+
- Unique identifier of the project. If omitted, uses the
90+
project ID in the profile or :ref:`environment variable
91+
<mcli-env-var>`.
92+
- no
93+
94+
.. _mcli-cm-monitoring-stop-output:
95+
96+
Output
97+
------
98+
99+
The command prints the following field to the terminal if
100+
the command succeeds. If the command prints an error, see
101+
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended
102+
solutions.
103+
104+
.. code-block:: none
105+
:copyable: false
106+
107+
Stopped monitoring '<hostId>'
108+
109+
.. _mcli-cm-monitoring-stop-egs:
110+
111+
Example
112+
-------
113+
114+
The following command uses the ``mongocli cloud-manager monitoring stop``
115+
command to stop the {+mdbagent+} from monitoring one host.
116+
It uses the default profile to access |cloud-short|.
117+
118+
.. code-block:: sh
119+
120+
mongocli cloud-manager monitoring stop 5c8100bcf2a30b12ff88258f
121+
Are you sure you want to delete: 5c8100bcf2a30b12ff88258f Yes
122+
123+
The previous command prints the following to the terminal.
124+
125+
.. code-block:: sh
126+
:copyable: false
127+
128+
Stopped monitoring '5c8100bcf2a30b12ff88258f'

‎source/reference/ops-manager.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ Ops Manager ``mongocli`` Commands
4444
:ref:`metric <mcli-reference-om-metric>`
4545
Lists metrics for MongoDB processes on a specified host.
4646

47+
:ref:`monitoring <mcli-reference-om-monitoring>`
48+
Manage Monitoring for a specified host.
49+
4750
:ref:`owner <mcli-reference-om-owner>`
4851
Creates the first user with the :opsmgr:`Global Owner
4952
</reference/user-roles/#global-owner-role>` role for an |mms|
@@ -81,6 +84,7 @@ Ops Manager ``mongocli`` Commands
8184
Logs </reference/ops-manager/log-commands>
8285
Maintenance Window </reference/ops-manager/maintenanceWindow-commands>
8386
Metrics </reference/ops-manager/metric-commands>
87+
Monitoring </reference/ops-manager/monitoring-commands>
8488
Owner </reference/ops-manager/owner-commands>
8589
Performance Advisor </reference/ops-manager/performanceadvisor-commands>
8690
Process </reference/ops-manager/process-commands>

‎source/reference/ops-manager/monitoring-commands.txt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _mcli-reference-om-monitoring:
2+
3+
===================================
4+
Ops Manager ``monitoring`` Commands
5+
===================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. toctree::
10+
:titlesonly:
11+
12+
Stop Monitoring One Host </reference/ops-manager/monitoring-stop>

‎source/reference/ops-manager/monitoring-stop.txt‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
.. _mcli-om-monitoring-stop-command:
2+
3+
====================================
4+
mongocli ops-manager monitoring stop
5+
====================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
The ``monitoring stop`` command stops the {+mdbagent+} from monitoring
16+
the host that you specify. You can also stop Monitoring for one host in
17+
|onprem| using the :opsmgr:`UI
18+
</tutorial/mongodb-agent-functions/#deactivate-monitoring>` and
19+
:opsmgr:`API </reference/api/hosts/delete-one-host/>`.
20+
21+
You must have :opsmgr:`Project Monitoring Admin
22+
</reference/user-roles/#Project-Monitoring-Admin>` or :opsmgr:`Project
23+
Owner </reference/user-roles/#Project-Owner>` role to stop the
24+
{+mdbagent+} from monitoring a host.
25+
26+
.. _mcli-om-monitoring-stop-syntax:
27+
28+
Syntax
29+
------
30+
31+
.. code-block:: sh
32+
33+
mongocli ops-manager|om monitoring stop <hostId>
34+
[ --force ]
35+
[ --profile|-P <profile-name> ]
36+
[ --projectId <project-ID> ]
37+
38+
.. _mcli-om-monitoring-stop-arguments:
39+
40+
Arguments
41+
---------
42+
43+
.. list-table::
44+
:header-rows: 1
45+
:widths: 20 10 60 10
46+
47+
* - Option
48+
- Type
49+
- Description
50+
- Required?
51+
52+
* - ``<hostId>``
53+
- string
54+
- Unique identifier of the host you want to stop monitoring.
55+
56+
Use the :ref:`mcli-om-process-list-cmd` command to retrieve
57+
unique identifiers for your hosts.
58+
59+
- yes
60+
61+
.. _mcli-om-monitoring-stop-options:
62+
63+
Options
64+
-------
65+
.. list-table::
66+
:header-rows: 1
67+
:widths: 20 10 60 10
68+
69+
* - Option
70+
- Type
71+
- Description
72+
- Required?
73+
74+
* - ``--force``
75+
-
76+
- Bypasses the confirmation prompt.
77+
- no
78+
79+
* - ``--profile``, ``-P``
80+
- string
81+
- Name of the profile where the public and private
82+
keys for the project are saved. If omitted, uses the
83+
{+default-profile+}. To learn more about creating a
84+
profile, see :ref:`mcli-configure`.
85+
- no
86+
87+
* - ``--projectId``
88+
- string
89+
- Unique identifier of the project. If omitted, uses the
90+
project ID in the profile or :ref:`environment variable
91+
<mcli-env-var>`.
92+
- no
93+
94+
.. _mcli-om-monitoring-stop-output:
95+
96+
Output
97+
------
98+
99+
The command prints the following field to the terminal if
100+
the command succeeds. If the command prints an error, see
101+
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended
102+
solutions.
103+
104+
.. code-block:: none
105+
:copyable: false
106+
107+
Stopped monitoring '<hostId>'
108+
109+
.. _mcli-om-monitoring-stop-egs:
110+
111+
Example
112+
-------
113+
114+
The following command uses the ``mongocli ops-manager monitoring stop``
115+
command to stop the {+mdbagent+} from monitoring one host.
116+
It uses the default profile to access |onprem|.
117+
118+
.. code-block:: sh
119+
120+
mongocli ops-manager monitoring stop 5c8100bcf2a30b12ff88258f
121+
Are you sure you want to delete: 5c8100bcf2a30b12ff88258f Yes
122+
123+
The previous command prints the following to the terminal.
124+
125+
.. code-block:: sh
126+
:copyable: false
127+
128+
Stopped monitoring '5c8100bcf2a30b12ff88258f'

0 commit comments

Comments
 (0)