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 `--version` `<luminous | nautilus>` ('default =' `nautilus`)::
103 Ceph version to install.
107 An alias for 'pveceph pool ls'.
109 *pveceph mds create* `[OPTIONS]`
111 Create Ceph Metadata Server (MDS)
113 `--hotstandby` `<boolean>` ('default =' `0`)::
115 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.
117 `--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::
119 The ID for the mds, when omitted the same as the nodename
121 *pveceph mds destroy* `<name>`
123 Destroy Ceph Metadata Server
125 `<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
127 The name (ID) of the mds
129 *pveceph mgr create* `[OPTIONS]`
133 `--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
135 The ID for the manager, when omitted the same as the nodename
137 *pveceph mgr destroy* `<id>`
139 Destroy Ceph Manager.
141 `<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
143 The ID of the manager
145 *pveceph mon create* `[OPTIONS]`
147 Create Ceph Monitor and Manager
149 `--mon-address` `<string>` ::
151 Overwrites autodetected monitor IP address. Must be in the public network of ceph.
153 `--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
155 The ID for the monitor, when omitted the same as the nodename
157 *pveceph mon destroy* `<monid>`
159 Destroy Ceph Monitor and Manager.
161 `<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
165 *pveceph osd create* `<dev>` `[OPTIONS]`
169 `<dev>`: `<string>` ::
173 `--db_dev` `<string>` ::
175 Block device name for block.db.
177 `--db_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
179 Size in GiB for block.db.
181 NOTE: Requires option(s): `db_dev`
183 `--encrypted` `<boolean>` ('default =' `0`)::
185 Enables encryption of the OSD.
187 `--wal_dev` `<string>` ::
189 Block device name for block.wal.
191 `--wal_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
193 Size in GiB for block.wal.
195 NOTE: Requires option(s): `wal_dev`
197 *pveceph osd destroy* `<osdid>` `[OPTIONS]`
201 `<osdid>`: `<integer>` ::
205 `--cleanup` `<boolean>` ('default =' `0`)::
207 If set, we remove partition table entries.
209 *pveceph pool create* `<name>` `[OPTIONS]`
213 `<name>`: `<string>` ::
215 The name of the pool. It must be unique.
217 `--add_storages` `<boolean>` ::
219 Configure VM and CT storage using the new pool.
221 `--application` `<cephfs | rbd | rgw>` ::
223 The application of the pool, 'rbd' by default.
225 `--crush_rule` `<string>` ::
227 The rule to use for mapping object placement in the cluster.
229 `--min_size` `<integer> (1 - 7)` ('default =' `2`)::
231 Minimum number of replicas per object
233 `--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
235 Number of placement groups.
237 `--size` `<integer> (1 - 7)` ('default =' `3`)::
239 Number of replicas per object
241 *pveceph pool destroy* `<name>` `[OPTIONS]`
245 `<name>`: `<string>` ::
247 The name of the pool. It must be unique.
249 `--force` `<boolean>` ('default =' `0`)::
251 If true, destroys pool even if in use
253 `--remove_storages` `<boolean>` ('default =' `0`)::
255 Remove all pveceph-managed storages configured for this pool
263 Destroy ceph related data and configuration files.
265 *pveceph start* `[<service>]`
269 `<service>`: `(ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
277 *pveceph stop* `[<service>]`
281 `<service>`: `(ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::