1 *pveceph* `<COMMAND> [ARGS] [OPTIONS]`
5 An alias for 'pveceph mgr create'.
9 An alias for 'pveceph mon create'.
13 An alias for 'pveceph osd create'.
17 An alias for 'pveceph pool create'.
21 An alias for 'pveceph mgr destroy'.
25 An alias for 'pveceph mon destroy'.
29 An alias for 'pveceph osd destroy'.
33 An alias for 'pveceph pool destroy'.
35 *pveceph fs create* `[OPTIONS]`
37 Create a Ceph filesystem
39 `--add-storage` `<boolean>` ('default =' `0`)::
41 Configure the created CephFS as storage for this cluster.
43 `--name` `<string>` ('default =' `cephfs`)::
45 The ceph filesystem name.
47 `--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
49 Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
51 *pveceph help* `[OPTIONS]`
53 Get help about specified command.
55 `--extra-args` `<array>` ::
57 Shows help for a specific command
59 `--verbose` `<boolean>` ::
61 Verbose output format.
63 *pveceph init* `[OPTIONS]`
65 Create initial ceph default configuration and setup symlinks.
67 `--cluster-network` `<string>` ::
69 Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it
71 NOTE: Requires option(s): `network`
73 `--disable_cephx` `<boolean>` ('default =' `0`)::
75 Disable cephx authentication.
77 WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!
79 `--min_size` `<integer> (1 - 7)` ('default =' `2`)::
81 Minimum number of available replicas per object to allow I/O
83 `--network` `<string>` ::
85 Use specific network for all ceph related traffic
87 `--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
89 Placement group bits, used to specify the default number of placement groups.
91 NOTE: 'osd pool default pg num' does not work for default pools.
93 `--size` `<integer> (1 - 7)` ('default =' `3`)::
95 Targeted number of replicas per object
97 *pveceph install* `[OPTIONS]`
99 Install ceph related packages.
101 `--allow-experimental` `<boolean>` ('default =' `0`)::
103 Allow experimental versions. Use with care!
105 `--test-repository` `<boolean>` ('default =' `0`)::
107 Use the test, not the main repository. Use with care!
109 `--version` `<octopus | pacific>` ('default =' `pacific`)::
111 Ceph version to install.
115 An alias for 'pveceph pool ls'.
117 *pveceph mds create* `[OPTIONS]`
119 Create Ceph Metadata Server (MDS)
121 `--hotstandby` `<boolean>` ('default =' `0`)::
123 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.
125 `--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::
127 The ID for the mds, when omitted the same as the nodename
129 *pveceph mds destroy* `<name>`
131 Destroy Ceph Metadata Server
133 `<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
135 The name (ID) of the mds
137 *pveceph mgr create* `[OPTIONS]`
141 `--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
143 The ID for the manager, when omitted the same as the nodename
145 *pveceph mgr destroy* `<id>`
147 Destroy Ceph Manager.
149 `<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
151 The ID of the manager
153 *pveceph mon create* `[OPTIONS]`
155 Create Ceph Monitor and Manager
157 `--mon-address` `<string>` ::
159 Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph.
161 `--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
163 The ID for the monitor, when omitted the same as the nodename
165 *pveceph mon destroy* `<monid>`
167 Destroy Ceph Monitor and Manager.
169 `<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
173 *pveceph osd create* `<dev>` `[OPTIONS]`
177 `<dev>`: `<string>` ::
181 `--crush-device-class` `<string>` ::
183 Set the device class of the OSD in crush.
185 `--db_dev` `<string>` ::
187 Block device name for block.db.
189 `--db_dev_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
191 Size in GiB for block.db.
193 NOTE: Requires option(s): `db_dev`
195 `--encrypted` `<boolean>` ('default =' `0`)::
197 Enables encryption of the OSD.
199 `--wal_dev` `<string>` ::
201 Block device name for block.wal.
203 `--wal_dev_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
205 Size in GiB for block.wal.
207 NOTE: Requires option(s): `wal_dev`
209 *pveceph osd destroy* `<osdid>` `[OPTIONS]`
213 `<osdid>`: `<integer>` ::
217 `--cleanup` `<boolean>` ('default =' `0`)::
219 If set, we remove partition table entries.
221 *pveceph pool create* `<name>` `[OPTIONS]`
225 `<name>`: `<string>` ::
227 The name of the pool. It must be unique.
229 `--add_storages` `<boolean>` ::
231 Configure VM and CT storage using the new pool.
233 `--application` `<cephfs | rbd | rgw>` ('default =' `rbd`)::
235 The application of the pool.
237 `--crush_rule` `<string>` ::
239 The rule to use for mapping object placement in the cluster.
241 `--min_size` `<integer> (1 - 7)` ('default =' `2`)::
243 Minimum number of replicas per object
245 `--pg_autoscale_mode` `<off | on | warn>` ('default =' `warn`)::
247 The automatic PG scaling mode of the pool.
249 `--pg_num` `<integer> (1 - 32768)` ('default =' `128`)::
251 Number of placement groups.
253 `--pg_num_min` `<integer> (-N - 32768)` ::
255 Minimal number of placement groups.
257 `--size` `<integer> (1 - 7)` ('default =' `3`)::
259 Number of replicas per object
261 `--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
263 The estimated target size of the pool for the PG autoscaler.
265 `--target_size_ratio` `<number>` ::
267 The estimated target ratio of the pool for the PG autoscaler.
269 *pveceph pool destroy* `<name>` `[OPTIONS]`
273 `<name>`: `<string>` ::
275 The name of the pool. It must be unique.
277 `--force` `<boolean>` ('default =' `0`)::
279 If true, destroys pool even if in use
281 `--remove_storages` `<boolean>` ('default =' `0`)::
283 Remove all pveceph-managed storages configured for this pool
285 *pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`
289 `<name>`: `<string>` ::
291 The name of the pool. It must be unique.
293 `--verbose` `<boolean>` ('default =' `0`)::
295 If enabled, will display additional data(eg. statistics).
297 *pveceph pool ls* `[FORMAT_OPTIONS]`
301 *pveceph pool set* `<name>` `[OPTIONS]`
305 `<name>`: `<string>` ::
307 The name of the pool. It must be unique.
309 `--application` `<cephfs | rbd | rgw>` ::
311 The application of the pool.
313 `--crush_rule` `<string>` ::
315 The rule to use for mapping object placement in the cluster.
317 `--min_size` `<integer> (1 - 7)` ::
319 Minimum number of replicas per object
321 `--pg_autoscale_mode` `<off | on | warn>` ::
323 The automatic PG scaling mode of the pool.
325 `--pg_num` `<integer> (1 - 32768)` ::
327 Number of placement groups.
329 `--pg_num_min` `<integer> (-N - 32768)` ::
331 Minimal number of placement groups.
333 `--size` `<integer> (1 - 7)` ::
335 Number of replicas per object
337 `--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
339 The estimated target size of the pool for the PG autoscaler.
341 `--target_size_ratio` `<number>` ::
343 The estimated target ratio of the pool for the PG autoscaler.
345 *pveceph purge* `[OPTIONS]`
347 Destroy ceph related data and configuration files.
349 `--crash` `<boolean>` ::
351 Additionally purge Ceph crash logs, /var/lib/ceph/crash.
353 `--logs` `<boolean>` ::
355 Additionally purge Ceph logs, /var/log/ceph.
357 *pveceph start* `[OPTIONS]`
361 `--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
369 *pveceph stop* `[OPTIONS]`
373 `--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::