1
- .. _mcli-om-admin-backup-sync-store- create-cmd:
1
+ .. _mcli-om-admin-backup-sync-create-cmd:
2
2
3
- ===================================================
4
- mongocli ops-manager admin backup sync store create
5
- ===================================================
3
+ =============================================
4
+ mongocli ops-manager admin backup sync create
5
+ =============================================
6
6
7
7
.. default-domain:: mongodb
8
8
@@ -14,25 +14,25 @@ mongocli ops-manager admin backup sync store create
14
14
15
15
.. include:: /includes/admonitions/admin-requires-global-owner.rst
16
16
17
- The ``admin backup sync store create`` command creates a new
18
- :opsmgr:`sync store </reference/glossary/#term-sync-store>`
19
- configuration. You can also
20
- create a sync store configuration using
21
- the :opsmgr:`API </reference/api/admin/backup/sync/mongoConfigs/create-one-sync-store-configuration/>`.
17
+ The ``admin backup sync create`` command creates a new
18
+ :opsmgr:`sync store </reference/glossary/#term-sync-store>`.
19
+ You can also create a sync store using the
20
+ :opsmgr:`API </reference/api/admin/backup/sync/mongoConfigs/create-one-sync-store-configuration/>`.
22
21
23
- .. _mcli-om-admin-backup-sync-store- create-syntax:
22
+ .. _mcli-om-admin-backup-sync-create-syntax:
24
23
25
24
Syntax
26
25
------
27
26
28
27
.. code-block:: shell
29
28
30
- mongocli ops-manager|om admin backup sync store(s) create
31
- [ --assignment ]
29
+ mongocli ops-manager|om admin backup sync create
30
+ [ --assignment ]
32
31
[ --encryptedCredentials ]
33
32
[ --label <tags> ]
34
- --name <sync-store-name>
33
+ [ --loadFactor <number-of-backup-jobs> ]
35
34
[ --maxCapacityGB <amount-of-data> ]
35
+ --name <sync-store-name>
36
36
[ --output|-o <output-format> ]
37
37
[ --profile|-P <profile-name> ]
38
38
[ --ssl ]
41
41
42
42
.. include:: /includes/fact-command-line-help.rst
43
43
44
- .. _mcli-om-admin-backup-sync-store- create-options:
44
+ .. _mcli-om-admin-backup-sync-create-options:
45
45
46
46
Options
47
47
-------
@@ -66,7 +66,7 @@ Options
66
66
-
67
67
- Flag that indicates whether the username and password for this
68
68
sync store were encrypted using the
69
- :opsmgr:`credentials tool </tutorial/encrypt-user-credentials/>`.
69
+ :opsmgr:`credentialstool </tutorial/encrypt-user-credentials/>`.
70
70
- no
71
71
72
72
* - ``--label``
@@ -78,16 +78,25 @@ Options
78
78
don't use labels to filter their jobs.
79
79
- no
80
80
81
- * - ``--name``
82
- - string
83
- - Name of the sync store.
84
- - yes
81
+ * - ``--loadFactor``
82
+ - number
83
+ - Required if more than one snapshot store is in use.
84
+
85
+ Number that expresses how much backup work this snapshot store
86
+ should perform compared to another snapshot store. Value must be
87
+ a positive, non-zero integer.
88
+ - no
85
89
86
90
* - ``--maxCapacityGB``
87
91
- number
88
92
- Maximum amount of data in GB that this sync store can store.
89
93
- no
90
94
95
+ * - ``--name``
96
+ - string
97
+ - Unique name for this sync store. This is also the sync store ID.
98
+ - yes
99
+
91
100
* - ``--output``, ``-o``
92
101
- string
93
102
- .. include:: /includes/extracts/fact-basic-options-output.rst
@@ -125,7 +134,7 @@ Options
125
134
126
135
- no
127
136
128
- .. _mcli-om-admin-backup-sync-store- create-output:
137
+ .. _mcli-om-admin-backup-sync-create-output:
129
138
130
139
Output
131
140
------
@@ -137,19 +146,19 @@ format. If the command returns errors, see
137
146
.. code-block:: sh
138
147
:copyable: false
139
148
140
- Sync store configuration '<sync-store-ID>' created.
149
+ Sync store '<sync-store-ID>' created.
141
150
142
151
The default output contains a subset of the fields returned by this
143
152
command. For the complete list of |json| fields returned by the
144
153
command, see the :opsmgr:`API reference
145
154
</reference/api/admin/backup/sync/mongoConfigs/create-one-sync-store-configuration/#response>`.
146
155
147
- .. _mcli-om-admin-backup-sync-store- create-egs:
156
+ .. _mcli-om-admin-backup-sync-create-egs:
148
157
149
158
Example
150
159
-------
151
160
152
- The following ``mongocli om admin backup sync store create`` command
161
+ The following ``mongocli om admin backup sync create`` command
153
162
creates the Sync store named ``test``. The command uses the
154
163
{+default-profile+}, which contains the credentials to access |onprem|.
155
164
@@ -160,22 +169,22 @@ creates the Sync store named ``test``. The command uses the
160
169
161
170
.. code-block:: shell
162
171
163
- mongocli om admin backup sync store create --name test
172
+ mongocli om admin backup sync create --name test
164
173
--uri mongodb://localhost:27017
165
174
166
175
The previous command returns the following:
167
176
168
177
.. code-block:: shell
169
178
:copyable: false
170
179
171
- Sync store configuration 'test' created.
180
+ Sync store 'test' created.
172
181
173
182
.. tab:: JSON Output
174
183
:tabid: json
175
184
176
185
.. code-block:: shell
177
186
178
- mongocli om admin backup sync store create --name test --uri mongodb://localhost:27017 --output json
187
+ mongocli om admin backup sync create --name test --uri mongodb://localhost:27017 --output json
179
188
180
189
The previous command returns the following:
181
190
0 commit comments