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 `--version` `<luminous | nautilus | octopus>` ('default =' `nautilus`)::
107 Ceph version to install.
111 An alias for 'pveceph pool ls'.
113 *pveceph mds create* `[OPTIONS]`
115 Create Ceph Metadata Server (MDS)
117 `--hotstandby` `<boolean>` ('default =' `0`)::
119 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.
121 `--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::
123 The ID for the mds, when omitted the same as the nodename
125 *pveceph mds destroy* `<name>`
127 Destroy Ceph Metadata Server
129 `<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
131 The name (ID) of the mds
133 *pveceph mgr create* `[OPTIONS]`
137 `--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
139 The ID for the manager, when omitted the same as the nodename
141 *pveceph mgr destroy* `<id>`
143 Destroy Ceph Manager.
145 `<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
147 The ID of the manager
149 *pveceph mon create* `[OPTIONS]`
151 Create Ceph Monitor and Manager
153 `--mon-address` `<string>` ::
155 Overwrites autodetected monitor IP address. Must be in the public network of ceph.
157 `--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
159 The ID for the monitor, when omitted the same as the nodename
161 *pveceph mon destroy* `<monid>`
163 Destroy Ceph Monitor and Manager.
165 `<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
169 *pveceph osd create* `<dev>` `[OPTIONS]`
173 `<dev>`: `<string>` ::
177 `--crush-device-class` `<string>` ::
179 Set the device class of the OSD in crush.
181 `--db_dev` `<string>` ::
183 Block device name for block.db.
185 `--db_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
187 Size in GiB for block.db.
189 NOTE: Requires option(s): `db_dev`
191 `--encrypted` `<boolean>` ('default =' `0`)::
193 Enables encryption of the OSD.
195 `--wal_dev` `<string>` ::
197 Block device name for block.wal.
199 `--wal_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
201 Size in GiB for block.wal.
203 NOTE: Requires option(s): `wal_dev`
205 *pveceph osd destroy* `<osdid>` `[OPTIONS]`
209 `<osdid>`: `<integer>` ::
213 `--cleanup` `<boolean>` ('default =' `0`)::
215 If set, we remove partition table entries.
217 *pveceph pool create* `<name>` `[OPTIONS]`
221 `<name>`: `<string>` ::
223 The name of the pool. It must be unique.
225 `--add_storages` `<boolean>` ::
227 Configure VM and CT storage using the new pool.
229 `--application` `<cephfs | rbd | rgw>` ('default =' `rbd`)::
231 The application of the pool.
233 `--crush_rule` `<string>` ::
235 The rule to use for mapping object placement in the cluster.
237 `--min_size` `<integer> (1 - 7)` ('default =' `2`)::
239 Minimum number of replicas per object
241 `--pg_autoscale_mode` `<off | on | warn>` ('default =' `warn`)::
243 The automatic PG scaling mode of the pool.
245 `--pg_num` `<integer> (1 - 32768)` ('default =' `128`)::
247 Number of placement groups.
249 `--pg_num_min` `<integer> (-N - 32768)` ::
251 Minimal number of placement groups.
253 `--size` `<integer> (1 - 7)` ('default =' `3`)::
255 Number of replicas per object
257 `--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
259 The estimated target size of the pool for the PG autoscaler.
261 `--target_size_ratio` `<number>` ::
263 The estimated target ratio of the pool for the PG autoscaler.
265 *pveceph pool destroy* `<name>` `[OPTIONS]`
269 `<name>`: `<string>` ::
271 The name of the pool. It must be unique.
273 `--force` `<boolean>` ('default =' `0`)::
275 If true, destroys pool even if in use
277 `--remove_storages` `<boolean>` ('default =' `0`)::
279 Remove all pveceph-managed storages configured for this pool
281 *pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`
285 `<name>`: `<string>` ::
287 The name of the pool. It must be unique.
289 `--verbose` `<boolean>` ('default =' `0`)::
291 If enabled, will display additional data(eg. statistics).
293 *pveceph pool ls* `[FORMAT_OPTIONS]`
297 *pveceph pool set* `<name>` `[OPTIONS]`
301 `<name>`: `<string>` ::
303 The name of the pool. It must be unique.
305 `--application` `<cephfs | rbd | rgw>` ::
307 The application of the pool.
309 `--crush_rule` `<string>` ::
311 The rule to use for mapping object placement in the cluster.
313 `--min_size` `<integer> (1 - 7)` ::
315 Minimum number of replicas per object
317 `--pg_autoscale_mode` `<off | on | warn>` ::
319 The automatic PG scaling mode of the pool.
321 `--pg_num` `<integer> (1 - 32768)` ::
323 Number of placement groups.
325 `--pg_num_min` `<integer> (-N - 32768)` ::
327 Minimal number of placement groups.
329 `--size` `<integer> (1 - 7)` ::
331 Number of replicas per object
333 `--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
335 The estimated target size of the pool for the PG autoscaler.
337 `--target_size_ratio` `<number>` ::
339 The estimated target ratio of the pool for the PG autoscaler.
341 *pveceph purge* `[OPTIONS]`
343 Destroy ceph related data and configuration files.
345 `--crash` `<boolean>` ::
347 Additionally purge Ceph crash logs, /var/lib/ceph/crash.
349 `--logs` `<boolean>` ::
351 Additionally purge Ceph logs, /var/log/ceph.
353 *pveceph start* `[OPTIONS]`
357 `--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
365 *pveceph stop* `[OPTIONS]`
369 `--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::