]>
Commit | Line | Data |
---|---|---|
0840a663 DM |
1 | *pveceph* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
e2d681b3 | 3 | *pveceph createmgr* |
0840a663 | 4 | |
e2d681b3 | 5 | An alias for 'pveceph mgr create'. |
2489d6df | 6 | |
e2d681b3 | 7 | *pveceph createmon* |
2489d6df | 8 | |
e2d681b3 | 9 | An alias for 'pveceph mon create'. |
2489d6df | 10 | |
e2d681b3 | 11 | *pveceph createosd* |
2489d6df | 12 | |
e2d681b3 | 13 | An alias for 'pveceph osd create'. |
2489d6df | 14 | |
e2d681b3 | 15 | *pveceph createpool* |
2489d6df | 16 | |
e2d681b3 | 17 | An alias for 'pveceph pool create'. |
2489d6df | 18 | |
e2d681b3 | 19 | *pveceph destroymgr* |
2489d6df | 20 | |
e2d681b3 | 21 | An alias for 'pveceph mgr destroy'. |
0840a663 | 22 | |
e2d681b3 | 23 | *pveceph destroymon* |
0840a663 | 24 | |
e2d681b3 | 25 | An alias for 'pveceph mon destroy'. |
0840a663 | 26 | |
e2d681b3 | 27 | *pveceph destroyosd* |
0840a663 | 28 | |
e2d681b3 | 29 | An alias for 'pveceph osd destroy'. |
0840a663 | 30 | |
e2d681b3 | 31 | *pveceph destroypool* |
0840a663 | 32 | |
e2d681b3 | 33 | An alias for 'pveceph pool destroy'. |
0840a663 | 34 | |
e2d681b3 | 35 | *pveceph fs create* `[OPTIONS]` |
5d9c884c | 36 | |
e2d681b3 | 37 | Create a Ceph filesystem |
5d9c884c | 38 | |
e2d681b3 | 39 | `--add-storage` `<boolean>` ('default =' `0`):: |
0840a663 | 40 | |
e2d681b3 | 41 | Configure the created CephFS as storage for this cluster. |
0840a663 | 42 | |
e2d681b3 | 43 | `--name` `<string>` ('default =' `cephfs`):: |
0840a663 | 44 | |
e2d681b3 | 45 | The ceph filesystem name. |
2489d6df | 46 | |
e2d681b3 | 47 | `--pg_num` `<integer> (8 - 32768)` ('default =' `128`):: |
2489d6df | 48 | |
e2d681b3 | 49 | Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. |
0840a663 | 50 | |
5370fa8c TL |
51 | *pveceph fs destroy* `<name>` `[OPTIONS]` |
52 | ||
53 | Destroy a Ceph filesystem | |
54 | ||
55 | `<name>`: `<string>` :: | |
56 | ||
57 | The ceph filesystem name. | |
58 | ||
59 | `--remove-pools` `<boolean>` ('default =' `0`):: | |
60 | ||
61 | Remove data and metadata pools configured for this fs. | |
62 | ||
63 | `--remove-storages` `<boolean>` ('default =' `0`):: | |
64 | ||
65 | Remove all pveceph-managed storages configured for this fs. | |
66 | ||
e2d681b3 | 67 | *pveceph help* `[OPTIONS]` |
0840a663 | 68 | |
e2d681b3 | 69 | Get help about specified command. |
0840a663 | 70 | |
e2d681b3 | 71 | `--extra-args` `<array>` :: |
0840a663 | 72 | |
e2d681b3 | 73 | Shows help for a specific command |
0840a663 | 74 | |
e2d681b3 | 75 | `--verbose` `<boolean>` :: |
2489d6df | 76 | |
e2d681b3 | 77 | Verbose output format. |
0840a663 | 78 | |
e2d681b3 | 79 | *pveceph init* `[OPTIONS]` |
0840a663 | 80 | |
e2d681b3 | 81 | Create initial ceph default configuration and setup symlinks. |
2489d6df | 82 | |
e2d681b3 | 83 | `--cluster-network` `<string>` :: |
2489d6df | 84 | |
e2d681b3 TL |
85 | Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it |
86 | + | |
87 | NOTE: Requires option(s): `network` | |
88 | ||
89 | `--disable_cephx` `<boolean>` ('default =' `0`):: | |
90 | ||
1e3f8156 | 91 | Disable cephx authentication. |
e2d681b3 TL |
92 | + |
93 | WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private! | |
2489d6df WB |
94 | |
95 | `--min_size` `<integer> (1 - 7)` ('default =' `2`):: | |
0840a663 | 96 | |
e2d681b3 | 97 | Minimum number of available replicas per object to allow I/O |
0840a663 | 98 | |
e2d681b3 | 99 | `--network` `<string>` :: |
0840a663 | 100 | |
e2d681b3 TL |
101 | Use specific network for all ceph related traffic |
102 | ||
103 | `--pg_bits` `<integer> (6 - 14)` ('default =' `6`):: | |
104 | ||
105 | Placement group bits, used to specify the default number of placement groups. | |
106 | + | |
fa22697b | 107 | Depreacted. This setting was deprecated in recent Ceph versions. |
0840a663 | 108 | |
2489d6df | 109 | `--size` `<integer> (1 - 7)` ('default =' `3`):: |
0840a663 | 110 | |
e2d681b3 TL |
111 | Targeted number of replicas per object |
112 | ||
113 | *pveceph install* `[OPTIONS]` | |
114 | ||
115 | Install ceph related packages. | |
116 | ||
ac70d7d1 TL |
117 | `--allow-experimental` `<boolean>` ('default =' `0`):: |
118 | ||
119 | Allow experimental versions. Use with care! | |
120 | ||
4a407cfd | 121 | `--repository` `<enterprise | no-subscription | test>` ('default =' `enterprise`):: |
0695fdaf | 122 | |
4a407cfd | 123 | Ceph repository to use. |
0695fdaf | 124 | |
82551b2b | 125 | `--version` `<quincy | reef>` ('default =' `quincy`):: |
e2d681b3 | 126 | |
1e3f8156 | 127 | Ceph version to install. |
e2d681b3 TL |
128 | |
129 | *pveceph lspools* | |
130 | ||
131 | An alias for 'pveceph pool ls'. | |
0840a663 | 132 | |
e2d681b3 TL |
133 | *pveceph mds create* `[OPTIONS]` |
134 | ||
135 | Create Ceph Metadata Server (MDS) | |
136 | ||
137 | `--hotstandby` `<boolean>` ('default =' `0`):: | |
138 | ||
139 | Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. | |
140 | ||
141 | `--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`):: | |
142 | ||
143 | The ID for the mds, when omitted the same as the nodename | |
144 | ||
145 | *pveceph mds destroy* `<name>` | |
146 | ||
147 | Destroy Ceph Metadata Server | |
148 | ||
149 | `<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: | |
150 | ||
151 | The name (ID) of the mds | |
152 | ||
153 | *pveceph mgr create* `[OPTIONS]` | |
154 | ||
155 | Create Ceph Manager | |
156 | ||
157 | `--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: | |
158 | ||
159 | The ID for the manager, when omitted the same as the nodename | |
160 | ||
161 | *pveceph mgr destroy* `<id>` | |
2489d6df WB |
162 | |
163 | Destroy Ceph Manager. | |
164 | ||
165 | `<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: | |
166 | ||
167 | The ID of the manager | |
168 | ||
e2d681b3 TL |
169 | *pveceph mon create* `[OPTIONS]` |
170 | ||
171 | Create Ceph Monitor and Manager | |
172 | ||
1e3f8156 | 173 | `--mon-address` `<string>` :: |
e2d681b3 | 174 | |
0695fdaf | 175 | Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph. |
e2d681b3 | 176 | |
1e3f8156 | 177 | `--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: |
e2d681b3 TL |
178 | |
179 | The ID for the monitor, when omitted the same as the nodename | |
180 | ||
1e3f8156 | 181 | *pveceph mon destroy* `<monid>` |
2489d6df WB |
182 | |
183 | Destroy Ceph Monitor and Manager. | |
184 | ||
185 | `<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: | |
0840a663 DM |
186 | |
187 | Monitor ID | |
188 | ||
e2d681b3 | 189 | *pveceph osd create* `<dev>` `[OPTIONS]` |
0840a663 | 190 | |
e2d681b3 | 191 | Create OSD |
0840a663 | 192 | |
e2d681b3 | 193 | `<dev>`: `<string>` :: |
0840a663 | 194 | |
e2d681b3 | 195 | Block device name. |
0840a663 | 196 | |
739d4d64 TL |
197 | `--crush-device-class` `<string>` :: |
198 | ||
199 | Set the device class of the OSD in crush. | |
200 | ||
1e3f8156 | 201 | `--db_dev` `<string>` :: |
0840a663 | 202 | |
1e3f8156 | 203 | Block device name for block.db. |
0840a663 | 204 | |
0695fdaf | 205 | `--db_dev_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`):: |
0840a663 | 206 | |
1e3f8156 TL |
207 | Size in GiB for block.db. |
208 | + | |
209 | NOTE: Requires option(s): `db_dev` | |
0840a663 | 210 | |
1e3f8156 | 211 | `--encrypted` `<boolean>` ('default =' `0`):: |
0840a663 | 212 | |
1e3f8156 | 213 | Enables encryption of the OSD. |
0840a663 | 214 | |
fa22697b TL |
215 | `--osds-per-device` `<integer> (1 - N)` :: |
216 | ||
217 | OSD services per physical device. Only useful for fast NVMe devices" | |
218 | ." to utilize their performance better. | |
219 | ||
e2d681b3 | 220 | `--wal_dev` `<string>` :: |
2c0dde61 | 221 | |
1e3f8156 TL |
222 | Block device name for block.wal. |
223 | ||
0695fdaf | 224 | `--wal_dev_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`):: |
1e3f8156 TL |
225 | |
226 | Size in GiB for block.wal. | |
227 | + | |
228 | NOTE: Requires option(s): `wal_dev` | |
2c0dde61 | 229 | |
e2d681b3 | 230 | *pveceph osd destroy* `<osdid>` `[OPTIONS]` |
2489d6df | 231 | |
e2d681b3 | 232 | Destroy OSD |
2489d6df | 233 | |
e2d681b3 | 234 | `<osdid>`: `<integer>` :: |
0840a663 | 235 | |
e2d681b3 | 236 | OSD ID |
0840a663 | 237 | |
e2d681b3 | 238 | `--cleanup` `<boolean>` ('default =' `0`):: |
0840a663 | 239 | |
e2d681b3 | 240 | If set, we remove partition table entries. |
0840a663 | 241 | |
159464a9 TL |
242 | *pveceph osd details* `<osdid>` `[OPTIONS]` `[FORMAT_OPTIONS]` |
243 | ||
244 | Get OSD details. | |
245 | ||
246 | `<osdid>`: `<string>` :: | |
247 | ||
248 | ID of the OSD | |
249 | ||
250 | `--verbose` `<boolean>` ('default =' `0`):: | |
251 | ||
252 | Print verbose information, same as json-pretty output format. | |
253 | ||
e2d681b3 | 254 | *pveceph pool create* `<name>` `[OPTIONS]` |
0840a663 | 255 | |
7af2edf9 | 256 | Create Ceph pool |
0840a663 | 257 | |
e2d681b3 | 258 | `<name>`: `<string>` :: |
0840a663 | 259 | |
e2d681b3 | 260 | The name of the pool. It must be unique. |
0840a663 | 261 | |
e6d66c2f | 262 | `--add_storages` `<boolean>` ('default =' `0; for erasure coded pools: 1`):: |
5d9c884c | 263 | |
e6d66c2f | 264 | Configure VM and CT storage using the new pool. |
5d9c884c | 265 | |
4772952b | 266 | `--application` `<cephfs | rbd | rgw>` ('default =' `rbd`):: |
5d9c884c | 267 | |
4772952b | 268 | The application of the pool. |
5d9c884c | 269 | |
e2d681b3 | 270 | `--crush_rule` `<string>` :: |
0840a663 | 271 | |
e2d681b3 | 272 | The rule to use for mapping object placement in the cluster. |
0840a663 | 273 | |
7af2edf9 TL |
274 | `--erasure-coding` `k=<integer> ,m=<integer> [,device-class=<class>] [,failure-domain=<domain>] [,profile=<profile>]` :: |
275 | ||
460359c5 | 276 | Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool. |
7af2edf9 | 277 | |
e2d681b3 | 278 | `--min_size` `<integer> (1 - 7)` ('default =' `2`):: |
0840a663 | 279 | |
e2d681b3 TL |
280 | Minimum number of replicas per object |
281 | ||
4772952b TL |
282 | `--pg_autoscale_mode` `<off | on | warn>` ('default =' `warn`):: |
283 | ||
284 | The automatic PG scaling mode of the pool. | |
285 | ||
d2656385 | 286 | `--pg_num` `<integer> (1 - 32768)` ('default =' `128`):: |
e2d681b3 TL |
287 | |
288 | Number of placement groups. | |
0840a663 | 289 | |
d2656385 TL |
290 | `--pg_num_min` `<integer> (-N - 32768)` :: |
291 | ||
292 | Minimal number of placement groups. | |
293 | ||
2489d6df | 294 | `--size` `<integer> (1 - 7)` ('default =' `3`):: |
0840a663 | 295 | |
e2d681b3 | 296 | Number of replicas per object |
0840a663 | 297 | |
d2656385 TL |
298 | `--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: |
299 | ||
300 | The estimated target size of the pool for the PG autoscaler. | |
301 | ||
302 | `--target_size_ratio` `<number>` :: | |
303 | ||
304 | The estimated target ratio of the pool for the PG autoscaler. | |
305 | ||
e2d681b3 | 306 | *pveceph pool destroy* `<name>` `[OPTIONS]` |
0840a663 | 307 | |
e2d681b3 | 308 | Destroy pool |
0840a663 | 309 | |
e2d681b3 | 310 | `<name>`: `<string>` :: |
0840a663 | 311 | |
e2d681b3 | 312 | The name of the pool. It must be unique. |
0840a663 | 313 | |
e2d681b3 TL |
314 | `--force` `<boolean>` ('default =' `0`):: |
315 | ||
316 | If true, destroys pool even if in use | |
317 | ||
7af2edf9 TL |
318 | `--remove_ecprofile` `<boolean>` ('default =' `1`):: |
319 | ||
320 | Remove the erasure code profile. Defaults to true, if applicable. | |
321 | ||
e2d681b3 TL |
322 | `--remove_storages` `<boolean>` ('default =' `0`):: |
323 | ||
324 | Remove all pveceph-managed storages configured for this pool | |
325 | ||
d2656385 TL |
326 | *pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]` |
327 | ||
9d2e98ed | 328 | Show the current pool status. |
d2656385 TL |
329 | |
330 | `<name>`: `<string>` :: | |
331 | ||
332 | The name of the pool. It must be unique. | |
333 | ||
334 | `--verbose` `<boolean>` ('default =' `0`):: | |
335 | ||
336 | If enabled, will display additional data(eg. statistics). | |
337 | ||
ac70d7d1 | 338 | *pveceph pool ls* `[FORMAT_OPTIONS]` |
0840a663 | 339 | |
9d2e98ed TL |
340 | List all pools and their settings (which are settable by the POST/PUT |
341 | endpoints). | |
0840a663 | 342 | |
4772952b TL |
343 | *pveceph pool set* `<name>` `[OPTIONS]` |
344 | ||
345 | Change POOL settings | |
346 | ||
347 | `<name>`: `<string>` :: | |
348 | ||
349 | The name of the pool. It must be unique. | |
350 | ||
351 | `--application` `<cephfs | rbd | rgw>` :: | |
352 | ||
353 | The application of the pool. | |
354 | ||
355 | `--crush_rule` `<string>` :: | |
356 | ||
357 | The rule to use for mapping object placement in the cluster. | |
358 | ||
359 | `--min_size` `<integer> (1 - 7)` :: | |
360 | ||
361 | Minimum number of replicas per object | |
362 | ||
363 | `--pg_autoscale_mode` `<off | on | warn>` :: | |
364 | ||
365 | The automatic PG scaling mode of the pool. | |
366 | ||
d2656385 | 367 | `--pg_num` `<integer> (1 - 32768)` :: |
4772952b TL |
368 | |
369 | Number of placement groups. | |
370 | ||
d2656385 TL |
371 | `--pg_num_min` `<integer> (-N - 32768)` :: |
372 | ||
373 | Minimal number of placement groups. | |
374 | ||
4772952b TL |
375 | `--size` `<integer> (1 - 7)` :: |
376 | ||
377 | Number of replicas per object | |
378 | ||
d2656385 TL |
379 | `--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: |
380 | ||
381 | The estimated target size of the pool for the PG autoscaler. | |
382 | ||
383 | `--target_size_ratio` `<number>` :: | |
384 | ||
385 | The estimated target ratio of the pool for the PG autoscaler. | |
386 | ||
ac70d7d1 | 387 | *pveceph purge* `[OPTIONS]` |
0840a663 DM |
388 | |
389 | Destroy ceph related data and configuration files. | |
390 | ||
ac70d7d1 TL |
391 | `--crash` `<boolean>` :: |
392 | ||
393 | Additionally purge Ceph crash logs, /var/lib/ceph/crash. | |
394 | ||
395 | `--logs` `<boolean>` :: | |
396 | ||
397 | Additionally purge Ceph logs, /var/log/ceph. | |
398 | ||
c5aa7e14 | 399 | *pveceph start* `[OPTIONS]` |
0840a663 DM |
400 | |
401 | Start ceph services. | |
402 | ||
c5aa7e14 | 403 | `--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`):: |
0840a663 DM |
404 | |
405 | Ceph service name. | |
406 | ||
0840a663 DM |
407 | *pveceph status* |
408 | ||
d2656385 | 409 | Get Ceph Status. |
0840a663 | 410 | |
c5aa7e14 | 411 | *pveceph stop* `[OPTIONS]` |
0840a663 DM |
412 | |
413 | Stop ceph services. | |
414 | ||
c5aa7e14 | 415 | `--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`):: |
0840a663 DM |
416 | |
417 | Ceph service name. | |
418 | ||
419 |