Skip to content

Commit cae84bb

Browse files
JuliaMongoJuliaMongo
committed
(DOCSP-12765), (DOCSP-12766), (DOCSP-12767), (DOCSP-12768), (DOCSP-12769) backup sync store commands: ran the tests and updated all examples
1 parent 70d794c commit cae84bb

File tree

5 files changed

+114
-142
lines changed

5 files changed

+114
-142
lines changed

‎source/reference/ops-manager/admin-backup-sync-create.txt

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Syntax
3131
[ --encryptedCredentials ]
3232
[ --label <tags> ]
3333
[ --loadFactor <number-of-backup-jobs> ]
34-
[ --maxCapacityGB <amount-of-data> ]
3534
--name <sync-store-name>
35+
[ --maxCapacityGB <amount-of-data> ]
3636
[ --output|-o <output-format> ]
3737
[ --profile|-P <profile-name> ]
3838
[ --ssl ]
@@ -43,11 +43,11 @@ Syntax
4343

4444
.. _mcli-om-admin-backup-sync-create-options:
4545

46-
Options
46+
Options
4747
-------
4848

4949
.. list-table::
50-
:widths: 20 10 60 10
50+
:widths: 30 10 50 10
5151
:header-rows: 1
5252

5353
* - Option
@@ -81,7 +81,6 @@ Options
8181
* - ``--loadFactor``
8282
- number
8383
- Required if more than one snapshot store is in use.
84-
8584
Number that expresses how much backup work this snapshot store
8685
should perform compared to another snapshot store. Value must be
8786
a positive, non-zero integer.
@@ -92,10 +91,10 @@ Options
9291
- Maximum amount of data in GB that this sync store can store.
9392
- no
9493

95-
* - ``--name``
96-
- string
97-
- Unique name for this sync store. This is also the sync store ID.
98-
- yes
94+
* - ``--name``
95+
- string
96+
- Unique name for this sync store. This is also the sync store ID.
97+
- yes
9998

10099
* - ``--output``, ``-o``
101100
- string
@@ -136,17 +135,17 @@ Options
136135

137136
.. _mcli-om-admin-backup-sync-create-output:
138137

139-
Output
138+
Output
140139
------
141140

142141
If the command succeeds, it returns the following message in the default
143142
format. If the command returns errors, see
144143
:ref:`Troubleshooting <mcli-troubleshooting>` for recommended solutions.
145144

146-
.. code-block:: sh
147-
:copyable: false
145+
.. code-block:: sh
146+
:copyable: false
148147

149-
Sync store '<sync-store-ID>' created.
148+
Sync store '<name>' created
150149

151150
The default output contains a subset of the fields returned by this
152151
command. For the complete list of |json| fields returned by the
@@ -160,42 +159,42 @@ Example
160159

161160
The following ``mongocli om admin backup sync create`` command
162161
creates the Sync store named ``test``. The command uses the
163-
{+default-profile+}, which contains the credentials to access |onprem|.
162+
{+default-profile+}, which contains the credentials for accessing
163+
|onprem|.
164164

165165
.. tabs::
166166

167-
.. tab:: Default Output
168-
:tabid: default
167+
.. tab:: Default Output
168+
:tabid: default
169169

170-
.. code-block:: shell
170+
.. code-block:: shell
171171

172172
mongocli om admin backup sync create --name test
173173
--uri mongodb://localhost:27017
174174

175-
The previous command returns the following:
175+
The previous command returns the following:
176176

177-
.. code-block:: shell
178-
:copyable: false
177+
.. code-block:: shell
178+
:copyable: false
179179

180-
Sync store 'test' created.
180+
Sync configuration 'test' created.
181181

182182
.. tab:: JSON Output
183183
:tabid: json
184184

185-
.. code-block:: shell
185+
.. code-block:: shell
186186

187-
mongocli om admin backup sync create --name test --uri mongodb://localhost:27017 --output json
187+
mongocli om admin backup sync create --name
188+
test --uri mongodb://localhost:27017 --output json
188189

189-
The previous command returns the following:
190+
The previous command returns the following:
190191

191-
.. code-block:: shell
192-
:copyable: false
192+
.. code-block:: shell
193+
:copyable: false
193194

194195
{
195-
"id": "test",
196+
"name": "test",
196197
"uri": "mongodb://localhost:27017",
197198
"ssl": false,
198-
"assignmentEnabled": false,
199-
"encryptedCredentials": false,
200199
"loadFactor": 1
201200
}

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

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ mongocli ops-manager admin backup sync delete
1515
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1616

1717
The ``admin backup sync delete`` command deletes the
18-
specified sync store. You can also delete the sync store
18+
specified :opsmgr:`sync store </reference/glossary/#term-sync-store>`.
19+
You can also delete the sync store
1920
using the :opsmgr:`API </reference/api/admin/backup/sync/mongoConfigs/delete-one-sync-store-configuration/>`.
2021

2122
.. _mcli-om-admin-backup-sync-syntax:
@@ -25,9 +26,9 @@ Syntax
2526

2627
.. code-block:: shell
2728

28-
mongocli ops-manager|om admin backup sync delete|rm<sync-store-config-ID>
29-
[ --force ]
30-
[ --profile|-P <profile-name> ]
29+
mongocli ops-manager|om admin backup sync delete|rm <name>
30+
[ --force ]
31+
[ --profile|-P <profile-name> ]
3132

3233
.. include:: /includes/fact-command-line-help.rst
3334

@@ -45,9 +46,9 @@ Arguments
4546
- Description
4647
- Required?
4748

48-
* - ``sync-store-config-ID``
49+
* - ``name``
4950
- string
50-
- Unique name of the sync store.
51+
- Unique name for this sync store. This is also the sync store ID.
5152
- yes
5253

5354
.. _mcli-om-admin-backup-sync-delete-options:
@@ -64,7 +65,7 @@ Options
6465
- Description
6566
- Required?
6667

67-
* - ``--force``
68+
* - ``--force``
6869
-
6970
- Flag that indicates that the configuration can
7071
be deleted without requiring confirmation.
@@ -78,32 +79,33 @@ Options
7879
profile, see :ref:`mcli-configure`.
7980
- no
8081

81-
.. _mcli-om-admin-backup-sync-delete-output:
82+
.. _mcli-om-admin-backup-sync-delete-output:
8283

8384
Output
8485
------
8586

8687
If the command succeeds, it returns the following message.
8788

88-
.. code-block:: sh
89-
:copyable: false
89+
.. code-block:: sh
90+
:copyable: false
9091

91-
Sync store configuration '<sync-store-config-ID>' deleted
92+
Sync store configuration '<name>' deleted
9293

93-
.. _mcli-om-admin-backup-sync-delete-egs:
94+
.. _mcli-om-admin-backup-sync-delete-egs:
9495

9596
Example
9697
-------
9798

9899
The following ``mongocli om admin backup sync delete`` command
99-
deletes the sync store whose ID is ``test``. The command usesthe ``--force`` option to bypass the confirmation prompt and the
100+
deletes the sync store named ``test``. The command uses the
101+
``--force`` option to bypass the confirmation prompt and the
100102
{+default-profile+} to access |onprem|.
101103

102104
.. code-block:: sh
103105

104106
mongocli om admin backup sync delete test --force
105107

106-
The previous command returns the following:
108+
The previous command returns the following:
107109

108110
.. code-block:: shell
109111
:copyable: false

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

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ mongocli ops-manager admin backup sync describe
1515
.. include:: /includes/admonitions/admin-requires-global-owner.rst
1616

1717
The ``admin backup sync describe`` command retrieves the
18-
configuration of the specified sync store. You can also
19-
retrieve the configuration of a sync store using
18+
configuration of the specified :opsmgr:`sync store </reference/glossary/#term-sync-store>`.
19+
You can also retrieve the configuration of a sync store using
2020
the :opsmgr:`API </reference/api/admin/backup/sync/mongoConfigs/get-one-sync-store-configuration-by-id/>`.
2121

2222
.. _mcli-om-admin-backup-sync-describe-syntax:
@@ -26,7 +26,7 @@ Syntax
2626

2727
.. code-block:: shell
2828

29-
mongocli ops-manager|om admin backup sync describe|get <sync-store-config-ID>
29+
mongocli ops-manager|om admin backup sync describe|get <name>
3030
[ --output|-o <output-format> ]
3131
[ --profile|-P <profile-name> ]
3232

@@ -44,11 +44,11 @@ Arguments
4444
- Description
4545
- Required?
4646

47-
* - ``sync-store-config-ID``
47+
* - ``name``
4848
- string
49-
- Unique identifier of the sync store that you want to
50-
describe. You can retrieve a list of sync store IDs for
51-
a project with the
49+
- Unique name for the sync store you want to describe. This is also
50+
the sync store ID. You can retrieve a list of sync store names for
51+
a project with the
5252
:ref:`List Backup Sync Store Configurations <mcli-om-admin-backup-sync-list-cmd>` command.
5353
- yes
5454

@@ -61,7 +61,7 @@ Options
6161
:widths: 20 10 60 10
6262
:header-rows: 1
6363

64-
* - Option
64+
* - Option
6565
- Type
6666
- Description
6767
- Required?
@@ -84,28 +84,30 @@ Options
8484
Output
8585
------
8686

87-
If the command succeeds, it returns the following output in the default format. If the command returns errors, see
88-
:ref:`Troubleshooting <mcli-troubleshooting>` for recommendedsolutions.
87+
If the command succeeds, it returns the following output in the default format.
88+
If the command returns errors, see :ref:`Troubleshooting <mcli-troubleshooting>`
89+
for recommendedsolutions.
8990

9091
.. code-block:: sh
9192
:copyable: false
9293

93-
ID PATH WT COMPRESSION MMAPV1 COMPRESSION
94-
<sync-store-config-ID> <store-path> NONE|GZIP NONE|GZIP
94+
NAME URI SSL LOAD FACTOR
95+
test mongodb://localhost:27017 false 1
96+
9597

96-
The default output contains a subset of the fields returned by this
97-
command. For the complete list of |json| fields returned by the
98+
The default output contains a subset of the fields returned by this
99+
command. For the complete list of |json| fields returned by the
98100
command, see the :opsmgr:`API reference
99101
</reference/api/admin/backup/sync/mongoConfigs/get-one-sync-store-configuration-by-id/#response>`.
100102

101-
.. _mcli-om-admin-backup-sync-describe-egs:
103+
.. _mcli-om-admin-backup-sync-describe-egs:
102104

103-
Example
105+
Example
104106
-------
105107

106108
The following ``mongocli om admin backup sync describe``
107-
command retrieves the configuration of the file system store whose
108-
ID is ``test``. The command uses the {+default-profile+} to access |onprem|.
109+
command retrieves the configuration of the sync store named
110+
``test``. The command uses the {+default-profile+} to access |onprem|.
109111

110112
.. tabs::
111113

@@ -116,31 +118,29 @@ ID is ``test``. The command uses the {+default-profile+} to access |onprem|.
116118

117119
mongocli om admin backup sync describe test
118120

119-
The previous command returns the following:
121+
The previous command returns the following:
120122

121-
.. code-block:: shell
122-
:copyable: false
123+
.. code-block:: shell
124+
:copyable: false
123125

124-
ID PATH WT COMPRESSION MMAPV1 COMPRESSION
125-
test / NONE GZIP
126+
NAME URI SSL LOAD FACTOR
127+
test mongodb://localhost:27017 false 1
126128

127-
.. tab:: JSON Output
128-
:tabid: json
129+
.. tab:: JSON Output
130+
:tabid: json
129131

130-
.. code-block:: shell
132+
.. code-block:: shell
131133

132134
mongocli om admin backup sync describe test --output json
133135

134136
The previous command returns the following:
135137

136-
.. code-block:: shell
137-
:copyable: false
138+
.. code-block:: shell
139+
:copyable: false
138140

139141
{
140-
"id": "test",
141-
"loadFactor": 1,
142-
"mmapv1CompressionSetting": "GZIP",
143-
"storePath": "/",
144-
"wtCompressionSetting": "NONE",
145-
"assignmentEnabled": true
142+
"name": "test",
143+
"uri": "mongodb://localhost:27017",
144+
"ssl": false",
145+
"loadFactor": 1
146146
}

0 commit comments

Comments
 (0)