Skip to content

Commit 17189d3

Browse files
zach-carrzach-carr
authored
(DOCSP-12540, 12541) admin backup blockstore list & describe (#282)
* (DOCSP-12540, 12541) admin backup blockstore list & describe
1 parent d97bc7d commit 17189d3

File tree

4 files changed

+311
-0
lines changed

4 files changed

+311
-0
lines changed

‎source/reference/ops-manager.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ Ops Manager ``mongocli`` Commands
66

77
.. default-domain:: mongodb
88

9+
:ref:`administration <mcli-reference-om-admin>`
10+
Manages administrative settings for your |mms| deployments.
11+
912
:ref:`agent <mcli-reference-om-agent>`
1013
Manages agents installed on your |mms| deployments.
1114

@@ -63,6 +66,7 @@ Ops Manager ``mongocli`` Commands
6366
.. toctree::
6467
:titlesonly:
6568

69+
Administration </reference/ops-manager/admin-commands>
6670
Agents </reference/ops-manager/agent-commands>
6771
Alerts </reference/ops-manager/alert-commands>
6872
Automation </reference/ops-manager/automation-commands>

‎source/reference/ops-manager/admin-backup-blockstore-describe.txt

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
.. _mcli-om-admin-backup-blockstore-describe-command:
2+
3+
=====================================================
4+
mongocli ops-manager admin backup blockstore describe
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 ``admin backup blockstore describe`` command retrieves
16+
configuration information for the specified backup blockstore.
17+
18+
.. _om-admin-backup-blockstore-describe-syntax:
19+
20+
Syntax
21+
------
22+
23+
.. code-block:: text
24+
25+
mongocli ops-manager|om admin backup blockstore describe|get <blockstore-id>
26+
[ --output|-o <output-format> ]
27+
[ --profile|-P <profile-name> ]
28+
29+
.. include:: /includes/fact-command-line-help.rst
30+
31+
Arguments
32+
---------
33+
34+
.. list-table::
35+
:header-rows: 1
36+
:widths: 20 10 60 10
37+
38+
* - Argument
39+
- Type
40+
- Description
41+
- Required?
42+
43+
* - ``<blockstore-id>``
44+
- string
45+
- Unique identifier of the blockstore that you
46+
want to describe. You can retrieve a list of blockstore IDs for
47+
a project with the
48+
:ref:`List Backup Blockstore Configurations <mcli-om-admin-backup-blockstore-list-cmd>` command.
49+
- yes
50+
51+
.. _om-admin-backup-blockstore-describe-options:
52+
53+
Options
54+
-------
55+
56+
.. list-table::
57+
:header-rows: 1
58+
:widths: 20 10 60 10
59+
60+
* - Option
61+
- Type
62+
- Description
63+
- Required?
64+
65+
* - ``--output``, ``-o``
66+
- string
67+
- .. include:: /includes/extracts/fact-basic-options-output.rst
68+
- no
69+
70+
* - ``--profile``, ``-P``
71+
- string
72+
- Name of the profile where the public and private
73+
keys for the project are saved. If omitted, uses the
74+
{+default-profile+}. To learn more about creating a
75+
profile, see :ref:`mcli-configure`.
76+
- no
77+
78+
.. _om-admin-backup-blockstore-describe-output:
79+
80+
Output
81+
------
82+
83+
.. include:: /includes/command-output-intro.rst
84+
85+
.. code-block:: sh
86+
:copyable: false
87+
88+
ID URI SSL LOAD FACTOR
89+
<id> <hostname>:<port> <boolean> <integer>
90+
91+
.. include:: /includes/fact-default-output.rst
92+
93+
- :opsmgr:`Ops Manager API </reference/api/admin/backup/snapshot/mongoConfigs/get-one-blockstore-configuration-by-id/>`
94+
95+
.. _om-admin-backup-blockstore-describe-examples:
96+
97+
Examples
98+
--------
99+
100+
.. tabs::
101+
102+
.. tab:: Default Output
103+
:tabid: default-output
104+
105+
The following command retrieves configuration information for a
106+
backup blockstore using the {+default-profile+}, which contains
107+
|onprem| credentials. The output is returned in the default
108+
format.
109+
110+
.. code-block:: sh
111+
112+
mongocli ops-manager admin backup blockstore describe blockstore
113+
114+
The previous command prints the following to the terminal.
115+
116+
.. code-block:: sh
117+
:copyable: false
118+
119+
ID URI SSL LOAD FACTOR
120+
blockstore mongodb://cluster-example.mongodb.net:27017 false 1
121+
122+
.. tab:: JSON Output
123+
:tabid: json-output
124+
125+
The following command retrieves configuration information for a
126+
backup blockstore using the {+default-profile+}, which contains
127+
|onprem| credentials. The output is returned in |json|
128+
format.
129+
130+
.. code-block:: sh
131+
132+
mongocli ops-manager admin backup blockstore describe blockstore -o json
133+
134+
The previous command prints the following to the terminal in
135+
|json| format.
136+
137+
.. code-block:: json
138+
:copyable: false
139+
140+
{
141+
"id": "blockstore",
142+
"uri": "mongodb://cluster-example.mongodb.net:27017",
143+
"ssl": false,
144+
"assignmentEnabled": true,
145+
"encryptedCredentials": false,
146+
"loadFactor": 1
147+
}

‎source/reference/ops-manager/admin-backup-blockstore-list.txt

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
.. _mcli-om-admin-backup-blockstore-list-cmd:
2+
3+
=================================================
4+
mongocli ops-manager admin backup blockstore list
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+
.. include:: /includes/styles/corrections.rst
16+
17+
The ``admin backup blockstore list`` command retrieves the list of
18+
backup blockstore configurations for your |onprem| deployment.
19+
20+
Syntax
21+
------
22+
23+
.. code-block:: text
24+
25+
mongocli ops-manager|om admin backup blockstore list|ls
26+
[ --limit <items-per-page> ]
27+
[ --page <page-number> ]
28+
[ --output|-o <output-format> ]
29+
[ --profile|-P <profile-name> ]
30+
31+
.. include:: /includes/fact-command-line-help.rst
32+
33+
Options
34+
-------
35+
36+
.. list-table::
37+
:widths: 20 10 60 10
38+
:header-rows: 1
39+
40+
* - Option
41+
- Type
42+
- Description
43+
- Required?
44+
45+
* - ``--limit``
46+
- integer
47+
- Number of items to return per page, up to a maximum of 500.
48+
Defaults to ``100`` if not specified.
49+
- no
50+
51+
* - ``--page``
52+
- integer
53+
- Page number (1-based). Defaults to ``1`` if not specified.
54+
- no
55+
56+
* - ``--output``, ``-o``
57+
- string
58+
- .. include:: /includes/extracts/fact-basic-options-output.rst
59+
- no
60+
61+
* - ``--profile``, ``-P``
62+
- string
63+
- Name of the profile where the public and private
64+
keys for the project are saved. If omitted, uses the
65+
{+default-profile+}. To learn more about creating a
66+
profile, see :ref:`mcli-configure`.
67+
- no
68+
69+
.. _mcli-om-admin-backup-blockstore-list-output:
70+
71+
Output
72+
------
73+
74+
.. include:: /includes/command-output-intro.rst
75+
76+
.. code-block:: sh
77+
:copyable: false
78+
79+
ID URI SSL LOAD FACTOR
80+
<id> <hostname>:<port> <boolean> <integer>
81+
82+
.. include:: /includes/fact-default-output.rst
83+
84+
- :opsmgr:`Ops Manager API </reference/api/admin/backup/snapshot/mongoConfigs/get-all-blockstore-configurations/>`
85+
86+
Examples
87+
--------
88+
89+
.. tabs::
90+
91+
.. tab:: Default Output
92+
:tabid: default-output
93+
94+
The following command retrieves the list of backup blockstore
95+
configurations using the {+default-profile+}, which contains
96+
|onprem| credentials. The output is returned in the default
97+
format.
98+
99+
.. code-block:: sh
100+
101+
mongocli ops-manager admin backup blockstore list
102+
103+
The previous command prints the following to the terminal.
104+
105+
.. code-block:: sh
106+
:copyable: false
107+
108+
ID URI SSL LOAD FACTOR
109+
blockstore mongodb://cluster-example.mongodb.net:27017 false 1
110+
111+
.. tab:: JSON Output
112+
:tabid: json-output
113+
114+
The following command retrieves the list of backup blockstore
115+
configurations using the {+default-profile+}, which contains
116+
|onprem| credentials. The output is returned in |json|
117+
format.
118+
119+
.. code-block:: sh
120+
121+
mongocli ops-manager admin backup blockstore list -o json
122+
123+
The previous command prints the following to the terminal in
124+
|json| format.
125+
126+
.. code-block:: json
127+
:copyable: false
128+
129+
{
130+
"links": [
131+
{
132+
"rel": "self",
133+
"href": "http://example:8080/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pageNum=1&itemsPerPage=100"
134+
}
135+
],
136+
"results": [
137+
{
138+
"id": "blockstore",
139+
"uri": "mongodb://cluster-example.mongodb.net:27017",
140+
"ssl": false,
141+
"assignmentEnabled": true,
142+
"encryptedCredentials": false,
143+
"loadFactor": 1
144+
}
145+
],
146+
"totalCount": 1
147+
}

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _mcli-reference-om-admin:
2+
3+
==============================
4+
Ops Manager ``admin`` commands
5+
==============================
6+
7+
.. default-domain:: mongodb
8+
9+
.. toctree::
10+
:titlesonly:
11+
12+
List Backup Blockstore Configurations </reference/ops-manager/admin-backup-blockstore-list>
13+
Describe a Backup Blockstore Configuration </reference/ops-manager/admin-backup-blockstore-describe>

0 commit comments

Comments
 (0)