Skip to content

Commit 2bfce14

Browse files
DOCSP-12462 doc for mongocli ops-manager versionManifest command (#314)
* DOCSP-12462 doc for mongocli ops-manager versionManifest command * DOCSP-12462 updates for review feedback * DOCSP-12462 updates for review feedback * Update source/reference/ops-manager/versionmanifest-update.txt Co-authored-by: John Williams <55147273+jwilliams-mongo@users.noreply.github.com> Co-authored-by: John Williams <55147273+jwilliams-mongo@users.noreply.github.com>
1 parent 1d3c1b7 commit 2bfce14

File tree

3 files changed

+186
-0
lines changed

3 files changed

+186
-0
lines changed

source/reference/ops-manager.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ Ops Manager ``mongocli`` Commands
6363
</tutorial/enable-mongodbcr-authentication-for-group/>` for the
6464
specified |mms| clusters in the given project.
6565

66+
:ref:`version manifest <mcli-reference-om-version-manifest>`
67+
Updates the version manifest in your |onprem| deployment.
68+
6669
.. toctree::
6770
:titlesonly:
6871

@@ -83,3 +86,4 @@ Ops Manager ``mongocli`` Commands
8386
Process </reference/ops-manager/process-commands>
8487
Security </reference/ops-manager/security-commands>
8588
Servers </reference/ops-manager/server-commands>
89+
Version Manifest </reference/ops-manager/version-manifest-commands>
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _mcli-reference-om-version-manifest:
2+
3+
========================================
4+
Ops Manager ``versionManifest`` commands
5+
========================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. toctree::
10+
:titlesonly:
11+
12+
Update the Version Manifest </reference/ops-manager/versionmanifest-update>
13+
Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
.. _mcli-om-versionmanifest-update-command:
2+
3+
===========================================
4+
mongocli ops-manager versionManifest update
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 ``versionManifest update`` command downloads and updates the :manual:`version
16+
manifest </reference/glossary/#term-version-manifest>` for the
17+
specified version from MongoDB. You can also update the version manifest through the
18+
|onprem| :opsmgr:`UI </tutorial/update-version-manifest/>` or
19+
:opsmgr:`API
20+
</reference/api/version-manifest/update-version-manifest/>`.
21+
22+
.. _mcli-om-versionmanifest-update-syntax:
23+
24+
Syntax
25+
------
26+
27+
.. code-block:: shell
28+
29+
mongocli ops-manager|om versionManifest|versionmanifest|version-manifest update <version>
30+
[ --output|-o <output-format> ]
31+
[ --profile|-P <profile-name> ]
32+
33+
.. include:: /includes/fact-command-line-help.rst
34+
35+
.. _mcli-om-versionmanifest-update-args:
36+
37+
Arguments
38+
---------
39+
40+
.. list-table::
41+
:header-rows: 1
42+
:widths: 20 10 60 10
43+
44+
* - Argument
45+
- Type
46+
- Description
47+
- Required?
48+
49+
* - ``<version>``
50+
- string
51+
- MongoDB version manifest to update. Valid values are:
52+
53+
- ``4.0``
54+
- ``4.2``
55+
- ``4.4``
56+
57+
- yes
58+
59+
.. _mcli-om-versionmanifest-update-options:
60+
61+
Options
62+
-------
63+
64+
.. list-table::
65+
:header-rows: 1
66+
:widths: 20 10 60 10
67+
68+
* - Option
69+
- Type
70+
- Description
71+
- Required?
72+
73+
* - ``--output``, ``-o``
74+
- string
75+
- .. include:: /includes/extracts/fact-basic-options-output.rst
76+
- no
77+
78+
* - ``--profile``, ``-P``
79+
- string
80+
- Name of the profile where the public and private
81+
keys for accessing |mms| are saved. If omitted, uses the
82+
{+default-profile+}. To learn more about creating a
83+
profile, see :ref:`mcli-configure`.
84+
- no
85+
86+
.. _mcli-om-versionmanifest-update-output:
87+
88+
Output
89+
------
90+
91+
If the command succeeds, it returns the following message in the default
92+
format. If the command returns errors, see
93+
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended solutions.
94+
95+
.. code-block:: sh
96+
:copyable: false
97+
98+
Version manifest updated.
99+
100+
If you request output in |json| format, the command returns the fields
101+
described in the :opsmgr:`API reference
102+
</reference/api/version-manifest/update-version-manifest/#response-body>`.
103+
104+
.. _mcli-om-versionmanifest-update-egs:
105+
106+
Example
107+
-------
108+
109+
The following ``mongocli om versionManifest`` command upgrades the
110+
MongoDB instances to v4.4. The command uses the {+default-profile+} to
111+
access the |onprem| deployment.
112+
113+
.. tabs::
114+
115+
.. tab:: Default Output
116+
:tabid: default
117+
118+
.. code-block:: shell
119+
120+
mongocli om versionManifest update 4.4
121+
122+
The previous command returns the following:
123+
124+
.. code-block:: shell
125+
:copyable: false
126+
127+
Version manifest updated.
128+
129+
.. tab:: JSON Output
130+
:tabid: json
131+
132+
.. code-block:: shell
133+
134+
mongocli om versionManifest update 4.4 --output json
135+
136+
The previous command returns the following:
137+
138+
.. code-block:: shell
139+
:copyable: false
140+
141+
{
142+
"updated": 1605642606044,
143+
"versions": [
144+
...
145+
{
146+
"name": "4.4.2-ent",
147+
"builds": [
148+
{
149+
"architecture": "ppc64le",
150+
"gitVersion": "15e73dc5738d2278b688f8929aee605fe4279b0e",
151+
"platform": "linux",
152+
"url": "/linux/mongodb-linux-ppc64le-enterprise-rhel71-4.4.2.tgz",
153+
"maxOsVersion": "8.0",
154+
"minOsVersion": "7.0",
155+
"flavor": "rhel"
156+
},
157+
{
158+
"architecture": "amd64",
159+
"gitVersion": "15e73dc5738d2278b688f8929aee605fe4279b0e",
160+
"platform": "linux",
161+
"url": "/linux/mongodb-linux-x86_64-enterprise-ubuntu2004-4.4.2.tgz",
162+
"maxOsVersion": "20.04",
163+
"minOsVersion": "19.04",
164+
"flavor": "ubuntu"
165+
},
166+
...
167+
}
168+
]
169+
}

0 commit comments

Comments
 (0)