Skip to content

Commit e411be8

Browse files
kanchana-mongodbkanchana-mongodb
authored
DOCSP-12630 mongocli om admin backup filesystem commands (#310)
1 parent 7446e2c commit e411be8

8 files changed

+438
-7
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Syntax
3131
[ --output|-o <output-format> ]
3232
[ --profile|-p <profile-name> ]
3333

34-
.. _mcli-om-admin-backup-blockstore-update-args:
34+
.. _mcli-om-admin-backup-blockstore-delete-args:
3535

3636
Arguments
3737
---------

‎source/reference/ops-manager/admin-backup-filesystem-delete.txt

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
.. _mcli-om-admin-backup-filesystem-delete-cmd:
2+
3+
===================================================
4+
mongocli ops-manager admin backup filesystem delete
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 filesystem delete`` command deletes the
18+
configuration of the specified file system store. You can also delete
19+
the configuration of a file system store using the :opsmgr:`API
20+
</reference/api/admin/backup/snapshot/fileSystemConfigs/delete-one-file-system-store-configuration/>`.
21+
22+
.. _mcli-om-admin-backup-filesystem-delete-syntax:
23+
24+
Syntax
25+
------
26+
27+
.. code-block:: shell
28+
29+
mongocli ops-manager|om admin backup filesystem|fileSystem delete <file-system-config-ID>
30+
[ --force ]
31+
[ --profile|-P <profile-name> ]
32+
33+
.. _mcli-om-admin-backup-filesystem-delete-args:
34+
35+
Arguments
36+
---------
37+
38+
.. list-table::
39+
:widths: 20 10 60 10
40+
:header-rows: 1
41+
42+
* - Option
43+
- Type
44+
- Description
45+
- Required?
46+
47+
* - ``file-system-config-ID``
48+
- string
49+
- Unique name of the file system store configuration.
50+
- yes
51+
52+
.. _mcli-om-admin-backup-filesystem-delete-options:
53+
54+
Options
55+
-------
56+
57+
.. list-table::
58+
:widths: 20 10 60 10
59+
:header-rows: 1
60+
61+
* - Option
62+
- Type
63+
- Description
64+
- Required?
65+
66+
* - ``--force``
67+
-
68+
- Flag that indicates that the configuration can
69+
be deleted without requiring confirmation.
70+
- no
71+
72+
* - ``--profile``, ``-P``
73+
- string
74+
- Name of the profile where the public and private
75+
keys for accessing |onprem| are saved. If omitted, uses the
76+
{+default-profile+}. To learn more about creating a
77+
profile, see :ref:`mcli-configure`.
78+
- no
79+
80+
.. _mcli-om-admin-backup-filesystem-delete-output:
81+
82+
Output
83+
------
84+
85+
If successful, the command returns the following message:
86+
87+
.. code-block:: shell
88+
:copyable: false
89+
90+
File system configuration '<configuration-ID>' deleted
91+
92+
.. _mcli-om-admin-backup-filesystem-delete-egs:
93+
94+
Example
95+
-------
96+
97+
The following example uses the ``mongocli om admin backup filesystem
98+
delete`` command to deletes the configuration of the file system store
99+
whose ID is ``test``. The command uses the ``--force`` option to bypass
100+
the confirmation prompt and the {+default-profile+} to access |onprem|.
101+
102+
.. code-block:: sh
103+
104+
mongocli om admin backup filesystem delete test --force
105+
106+
The previous command returns the following:
107+
108+
.. code-block:: shell
109+
:copyable: false
110+
111+
File system configuration 'test' deleted
112+

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

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
.. _mcli-om-admin-backup-filesystem-describe-cmd:
2+
3+
=====================================================
4+
mongocli ops-manager admin backup filesystem 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+
.. include:: /includes/styles/corrections.rst
16+
17+
The ``admin backup filesystem describe`` command retrieves the
18+
configuration of the specified file system store. You can also
19+
retrieve the configuration of a file system store using
20+
the :opsmgr:`API </reference/api/admin/backup/snapshot/fileSystemConfigs/get-one-file-system-store-configuration-by-id/>`.
21+
22+
.. _mcli-om-admin-backup-filesystem-describe-syntax:
23+
24+
Syntax
25+
------
26+
27+
.. code-block:: shell
28+
29+
mongocli ops-manager|om admin backup filesystem|fileSystem describe|get <file-system-config-ID>
30+
[ --output|-o <output-format> ]
31+
[ --profile|-P <profile-name> ]
32+
33+
.. _mcli-om-admin-backup-filesystem-describe-args:
34+
35+
Arguments
36+
---------
37+
38+
.. list-table::
39+
:widths: 20 10 60 10
40+
:header-rows: 1
41+
42+
* - Option
43+
- Type
44+
- Description
45+
- Required?
46+
47+
* - ``file-system-config-ID``
48+
- string
49+
- Unique name of the file system store configuration.
50+
- yes
51+
52+
.. _mcli-om-admin-backup-filesystem-describe-options:
53+
54+
Options
55+
-------
56+
57+
.. list-table::
58+
:widths: 20 10 60 10
59+
:header-rows: 1
60+
61+
* - Option
62+
- Type
63+
- Description
64+
- Required?
65+
66+
* - ``--output``, ``-o``
67+
- string
68+
- .. include:: /includes/extracts/fact-basic-options-output.rst
69+
- no
70+
71+
* - ``--profile``, ``-P``
72+
- string
73+
- Name of the profile where the public and private
74+
keys for accessing |onprem| are saved. If omitted, uses the
75+
{+default-profile+}. To learn more about creating a
76+
profile, see :ref:`mcli-configure`.
77+
- no
78+
79+
.. _mcli-om-admin-backup-filesystem-describe-output:
80+
81+
Output
82+
------
83+
84+
If the command succeeds, it returns the following output in the default
85+
format. If the command returns errors, see
86+
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended solutions.
87+
88+
.. code-block:: sh
89+
:copyable: false
90+
91+
ID PATH WT COMPRESSION MMAPV1 COMPRESSION
92+
<file-system-ID> <store-path> NONE|GZIP NONE|GZIP
93+
94+
The default output contains a subset of the fields returned by this
95+
command. For the complete list of |json| fields returned by the
96+
command, see the :opsmgr:`API reference
97+
</reference/api/admin/backup/snapshot/fileSystemConfigs/get-one-file-system-store-configuration-by-id/#response>`.
98+
99+
.. _mcli-om-admin-backup-filesystem-describe-egs:
100+
101+
Example
102+
-------
103+
104+
The following ``mongocli om admin backup filesystem describe`` command
105+
retrieves the configuration of the file system store whose ID is
106+
``test``. The command uses the {+default-profile+} to access |onprem|.
107+
108+
.. tabs::
109+
110+
.. tab:: Default Output
111+
:tabid: default
112+
113+
.. code-block:: shell
114+
115+
mongocli om admin backup filesystem describe test
116+
117+
The previous command returns the following:
118+
119+
.. code-block:: shell
120+
:copyable: false
121+
122+
ID PATH WT COMPRESSION MMAPV1 COMPRESSION
123+
test / NONE GZIP
124+
125+
.. tab:: JSON Output
126+
:tabid: json
127+
128+
.. code-block:: shell
129+
130+
mongocli om admin backup filesystem describe test --output json
131+
132+
The previous command returns the following:
133+
134+
.. code-block:: shell
135+
:copyable: false
136+
137+
{
138+
"id": "test",
139+
"loadFactor": 1,
140+
"mmapv1CompressionSetting": "GZIP",
141+
"storePath": "/",
142+
"wtCompressionSetting": "NONE",
143+
"assignmentEnabled": true
144+
}

0 commit comments

Comments
 (0)