[pve-docs.git] / pveceph.1-synopsis.adoc

*pveceph* `<COMMAND> [ARGS] [OPTIONS]`

*pveceph createmgr*

An alias for 'pveceph mgr create'.

*pveceph createmon*

An alias for 'pveceph mon create'.

*pveceph createosd*

An alias for 'pveceph osd create'.

*pveceph createpool*

An alias for 'pveceph pool create'.

*pveceph destroymgr*

An alias for 'pveceph mgr destroy'.

*pveceph destroymon*

An alias for 'pveceph mon destroy'.

*pveceph destroyosd*

An alias for 'pveceph osd destroy'.

*pveceph destroypool*

An alias for 'pveceph pool destroy'.

*pveceph fs create* `[OPTIONS]`

Create a Ceph filesystem

`--add-storage` `<boolean>` ('default =' `0`)::

Configure the created CephFS as storage for this cluster.

`--name` `<string>` ('default =' `cephfs`)::

The ceph filesystem name.

`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::

Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.

*pveceph fs destroy* `<name>` `[OPTIONS]`

Destroy a Ceph filesystem

`<name>`: `<string>` ::

The ceph filesystem name.

`--remove-pools` `<boolean>` ('default =' `0`)::

Remove data and metadata pools configured for this fs.

`--remove-storages` `<boolean>` ('default =' `0`)::

Remove all pveceph-managed storages configured for this fs.

*pveceph help* `[OPTIONS]`

Get help about specified command.

`--extra-args` `<array>` ::

Shows help for a specific command

`--verbose` `<boolean>` ::

Verbose output format.

*pveceph init* `[OPTIONS]`

Create initial ceph default configuration and setup symlinks.

`--cluster-network` `<string>` ::

Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it
+
NOTE: Requires option(s): `network`

`--disable_cephx` `<boolean>` ('default =' `0`)::

Disable cephx authentication.
+
WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!

`--min_size` `<integer> (1 - 7)` ('default =' `2`)::

Minimum number of available replicas per object to allow I/O

`--network` `<string>` ::

Use specific network for all ceph related traffic

`--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::

Placement group bits, used to specify the default number of placement groups.
+
NOTE: 'osd pool default pg num' does not work for default pools.

`--size` `<integer> (1 - 7)` ('default =' `3`)::

Targeted number of replicas per object

*pveceph install* `[OPTIONS]`

Install ceph related packages.

`--allow-experimental` `<boolean>` ('default =' `0`)::

Allow experimental versions. Use with care!

`--test-repository` `<boolean>` ('default =' `0`)::

Use the test, not the main repository. Use with care!

`--version` `<octopus | pacific>` ('default =' `pacific`)::

Ceph version to install.

*pveceph lspools*

An alias for 'pveceph pool ls'.

*pveceph mds create* `[OPTIONS]`

Create Ceph Metadata Server (MDS)

`--hotstandby` `<boolean>` ('default =' `0`)::

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.

`--name` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ('default =' `nodename`)::

The ID for the mds, when omitted the same as the nodename

*pveceph mds destroy* `<name>`

Destroy Ceph Metadata Server

`<name>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::

The name (ID) of the mds

*pveceph mgr create* `[OPTIONS]`

Create Ceph Manager

`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::

The ID for the manager, when omitted the same as the nodename

*pveceph mgr destroy* `<id>`

Destroy Ceph Manager.

`<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::

The ID of the manager

*pveceph mon create* `[OPTIONS]`

Create Ceph Monitor and Manager

`--mon-address` `<string>` ::

Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph.

`--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::

The ID for the monitor, when omitted the same as the nodename

*pveceph mon destroy* `<monid>`

Destroy Ceph Monitor and Manager.

`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::

Monitor ID

*pveceph osd create* `<dev>` `[OPTIONS]`

Create OSD

`<dev>`: `<string>` ::

Block device name.

`--crush-device-class` `<string>` ::

Set the device class of the OSD in crush.

`--db_dev` `<string>` ::

Block device name for block.db.

`--db_dev_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::

Size in GiB for block.db.
+
NOTE: Requires option(s): `db_dev`

`--encrypted` `<boolean>` ('default =' `0`)::

Enables encryption of the OSD.

`--wal_dev` `<string>` ::

Block device name for block.wal.

`--wal_dev_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::

Size in GiB for block.wal.
+
NOTE: Requires option(s): `wal_dev`

*pveceph osd destroy* `<osdid>` `[OPTIONS]`

Destroy OSD

`<osdid>`: `<integer>` ::

OSD ID

`--cleanup` `<boolean>` ('default =' `0`)::

If set, we remove partition table entries.

*pveceph pool create* `<name>` `[OPTIONS]`

Create Ceph pool

`<name>`: `<string>` ::

The name of the pool. It must be unique.

`--add_storages` `<boolean>` ('default =' `0; for erasure coded pools: 1`)::

Configure VM and CT storage using the new pool.

`--application` `<cephfs | rbd | rgw>` ('default =' `rbd`)::

The application of the pool.

`--crush_rule` `<string>` ::

The rule to use for mapping object placement in the cluster.

`--erasure-coding` `k=<integer> ,m=<integer> [,device-class=<class>] [,failure-domain=<domain>] [,profile=<profile>]` ::

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.

`--min_size` `<integer> (1 - 7)` ('default =' `2`)::

Minimum number of replicas per object

`--pg_autoscale_mode` `<off | on | warn>` ('default =' `warn`)::

The automatic PG scaling mode of the pool.

`--pg_num` `<integer> (1 - 32768)` ('default =' `128`)::

Number of placement groups.

`--pg_num_min` `<integer> (-N - 32768)` ::

Minimal number of placement groups.

`--size` `<integer> (1 - 7)` ('default =' `3`)::

Number of replicas per object

`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::

The estimated target size of the pool for the PG autoscaler.

`--target_size_ratio` `<number>` ::

The estimated target ratio of the pool for the PG autoscaler.

*pveceph pool destroy* `<name>` `[OPTIONS]`

Destroy pool

`<name>`: `<string>` ::

The name of the pool. It must be unique.

`--force` `<boolean>` ('default =' `0`)::

If true, destroys pool even if in use

`--remove_ecprofile` `<boolean>` ('default =' `1`)::

Remove the erasure code profile. Defaults to true, if applicable.

`--remove_storages` `<boolean>` ('default =' `0`)::

Remove all pveceph-managed storages configured for this pool

*pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`

List pool settings.

`<name>`: `<string>` ::

The name of the pool. It must be unique.

`--verbose` `<boolean>` ('default =' `0`)::

If enabled, will display additional data(eg. statistics).

*pveceph pool ls* `[FORMAT_OPTIONS]`

List all pools.

*pveceph pool set* `<name>` `[OPTIONS]`

Change POOL settings

`<name>`: `<string>` ::

The name of the pool. It must be unique.

`--application` `<cephfs | rbd | rgw>` ::

The application of the pool.

`--crush_rule` `<string>` ::

The rule to use for mapping object placement in the cluster.

`--min_size` `<integer> (1 - 7)` ::

Minimum number of replicas per object

`--pg_autoscale_mode` `<off | on | warn>` ::

The automatic PG scaling mode of the pool.

`--pg_num` `<integer> (1 - 32768)` ::

Number of placement groups.

`--pg_num_min` `<integer> (-N - 32768)` ::

Minimal number of placement groups.

`--size` `<integer> (1 - 7)` ::

Number of replicas per object

`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::

The estimated target size of the pool for the PG autoscaler.

`--target_size_ratio` `<number>` ::

The estimated target ratio of the pool for the PG autoscaler.

*pveceph purge* `[OPTIONS]`

Destroy ceph related data and configuration files.

`--crash` `<boolean>` ::

Additionally purge Ceph crash logs, /var/lib/ceph/crash.

`--logs` `<boolean>` ::

Additionally purge Ceph logs, /var/log/ceph.

*pveceph start* `[OPTIONS]`

Start ceph services.

`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::

Ceph service name.

*pveceph status*

Get Ceph Status.

*pveceph stop* `[OPTIONS]`

Stop ceph services.

`--service` `(ceph|mon|mds|osd|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::

Ceph service name.
Commit	Line	Data
	1	pveceph `<COMMAND> [ARGS] [OPTIONS]`
	2
	3	pveceph createmgr
	4
	5	An alias for 'pveceph mgr create'.
	6
	7	pveceph createmon
	8
	9	An alias for 'pveceph mon create'.
	10
	11	pveceph createosd
	12
	13	An alias for 'pveceph osd create'.
	14
	15	pveceph createpool
	16
	17	An alias for 'pveceph pool create'.
	18
	19	pveceph destroymgr
	20
	21	An alias for 'pveceph mgr destroy'.
	22
	23	pveceph destroymon
	24
	25	An alias for 'pveceph mon destroy'.
	26
	27	pveceph destroyosd
	28
	29	An alias for 'pveceph osd destroy'.
	30
	31	pveceph destroypool
	32
	33	An alias for 'pveceph pool destroy'.
	34
	35	pveceph fs create `[OPTIONS]`
	36
	37	Create a Ceph filesystem
	38
	39	`--add-storage` `<boolean>` ('default =' `0`)::
	40
	41	Configure the created CephFS as storage for this cluster.
	42
	43	`--name` `<string>` ('default =' `cephfs`)::
	44
	45	The ceph filesystem name.
	46
	47	`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
	48
	49	Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
	50
	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
	67	pveceph help `[OPTIONS]`
	68
	69	Get help about specified command.
	70
	71	`--extra-args` `<array>` ::
	72
	73	Shows help for a specific command
	74
	75	`--verbose` `<boolean>` ::
	76
	77	Verbose output format.
	78
	79	pveceph init `[OPTIONS]`
	80
	81	Create initial ceph default configuration and setup symlinks.
	82
	83	`--cluster-network` `<string>` ::
	84
	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
	91	Disable cephx authentication.
	92	+
	93	WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!
	94
	95	`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
	96
	97	Minimum number of available replicas per object to allow I/O
	98
	99	`--network` `<string>` ::
	100
	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	+
	107	NOTE: 'osd pool default pg num' does not work for default pools.
	108
	109	`--size` `<integer> (1 - 7)` ('default =' `3`)::
	110
	111	Targeted number of replicas per object
	112
	113	pveceph install `[OPTIONS]`
	114
	115	Install ceph related packages.
	116
	117	`--allow-experimental` `<boolean>` ('default =' `0`)::
	118
	119	Allow experimental versions. Use with care!
	120
	121	`--test-repository` `<boolean>` ('default =' `0`)::
	122
	123	Use the test, not the main repository. Use with care!
	124
	125	`--version` `<octopus \| pacific>` ('default =' `pacific`)::
	126
	127	Ceph version to install.
	128
	129	pveceph lspools
	130
	131	An alias for 'pveceph pool ls'.
	132
	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>`
	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
	169	pveceph mon create `[OPTIONS]`
	170
	171	Create Ceph Monitor and Manager
	172
	173	`--mon-address` `<string>` ::
	174
	175	Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph.
	176
	177	`--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
	178
	179	The ID for the monitor, when omitted the same as the nodename
	180
	181	pveceph mon destroy `<monid>`
	182
	183	Destroy Ceph Monitor and Manager.
	184
	185	`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::
	186
	187	Monitor ID
	188
	189	pveceph osd create `<dev>` `[OPTIONS]`
	190
	191	Create OSD
	192
	193	`<dev>`: `<string>` ::
	194
	195	Block device name.
	196
	197	`--crush-device-class` `<string>` ::
	198
	199	Set the device class of the OSD in crush.
	200
	201	`--db_dev` `<string>` ::
	202
	203	Block device name for block.db.
	204
	205	`--db_dev_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
	206
	207	Size in GiB for block.db.
	208	+
	209	NOTE: Requires option(s): `db_dev`
	210
	211	`--encrypted` `<boolean>` ('default =' `0`)::
	212
	213	Enables encryption of the OSD.
	214
	215	`--wal_dev` `<string>` ::
	216
	217	Block device name for block.wal.
	218
	219	`--wal_dev_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
	220
	221	Size in GiB for block.wal.
	222	+
	223	NOTE: Requires option(s): `wal_dev`
	224
	225	pveceph osd destroy `<osdid>` `[OPTIONS]`
	226
	227	Destroy OSD
	228
	229	`<osdid>`: `<integer>` ::
	230
	231	OSD ID
	232
	233	`--cleanup` `<boolean>` ('default =' `0`)::
	234
	235	If set, we remove partition table entries.
	236
	237	pveceph pool create `<name>` `[OPTIONS]`
	238
	239	Create Ceph pool
	240
	241	`<name>`: `<string>` ::
	242
	243	The name of the pool. It must be unique.
	244
	245	`--add_storages` `<boolean>` ('default =' `0; for erasure coded pools: 1`)::
	246
	247	Configure VM and CT storage using the new pool.
	248
	249	`--application` `<cephfs \| rbd \| rgw>` ('default =' `rbd`)::
	250
	251	The application of the pool.
	252
	253	`--crush_rule` `<string>` ::
	254
	255	The rule to use for mapping object placement in the cluster.
	256
	257	`--erasure-coding` `k=<integer> ,m=<integer> [,device-class=<class>] [,failure-domain=<domain>] [,profile=<profile>]` ::
	258
	259	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.
	260
	261	`--min_size` `<integer> (1 - 7)` ('default =' `2`)::
	262
	263	Minimum number of replicas per object
	264
	265	`--pg_autoscale_mode` `<off \| on \| warn>` ('default =' `warn`)::
	266
	267	The automatic PG scaling mode of the pool.
	268
	269	`--pg_num` `<integer> (1 - 32768)` ('default =' `128`)::
	270
	271	Number of placement groups.
	272
	273	`--pg_num_min` `<integer> (-N - 32768)` ::
	274
	275	Minimal number of placement groups.
	276
	277	`--size` `<integer> (1 - 7)` ('default =' `3`)::
	278
	279	Number of replicas per object
	280
	281	`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
	282
	283	The estimated target size of the pool for the PG autoscaler.
	284
	285	`--target_size_ratio` `<number>` ::
	286
	287	The estimated target ratio of the pool for the PG autoscaler.
	288
	289	pveceph pool destroy `<name>` `[OPTIONS]`
	290
	291	Destroy pool
	292
	293	`<name>`: `<string>` ::
	294
	295	The name of the pool. It must be unique.
	296
	297	`--force` `<boolean>` ('default =' `0`)::
	298
	299	If true, destroys pool even if in use
	300
	301	`--remove_ecprofile` `<boolean>` ('default =' `1`)::
	302
	303	Remove the erasure code profile. Defaults to true, if applicable.
	304
	305	`--remove_storages` `<boolean>` ('default =' `0`)::
	306
	307	Remove all pveceph-managed storages configured for this pool
	308
	309	pveceph pool get `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`
	310
	311	List pool settings.
	312
	313	`<name>`: `<string>` ::
	314
	315	The name of the pool. It must be unique.
	316
	317	`--verbose` `<boolean>` ('default =' `0`)::
	318
	319	If enabled, will display additional data(eg. statistics).
	320
	321	pveceph pool ls `[FORMAT_OPTIONS]`
	322
	323	List all pools.
	324
	325	pveceph pool set `<name>` `[OPTIONS]`
	326
	327	Change POOL settings
	328
	329	`<name>`: `<string>` ::
	330
	331	The name of the pool. It must be unique.
	332
	333	`--application` `<cephfs \| rbd \| rgw>` ::
	334
	335	The application of the pool.
	336
	337	`--crush_rule` `<string>` ::
	338
	339	The rule to use for mapping object placement in the cluster.
	340
	341	`--min_size` `<integer> (1 - 7)` ::
	342
	343	Minimum number of replicas per object
	344
	345	`--pg_autoscale_mode` `<off \| on \| warn>` ::
	346
	347	The automatic PG scaling mode of the pool.
	348
	349	`--pg_num` `<integer> (1 - 32768)` ::
	350
	351	Number of placement groups.
	352
	353	`--pg_num_min` `<integer> (-N - 32768)` ::
	354
	355	Minimal number of placement groups.
	356
	357	`--size` `<integer> (1 - 7)` ::
	358
	359	Number of replicas per object
	360
	361	`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
	362
	363	The estimated target size of the pool for the PG autoscaler.
	364
	365	`--target_size_ratio` `<number>` ::
	366
	367	The estimated target ratio of the pool for the PG autoscaler.
	368
	369	pveceph purge `[OPTIONS]`
	370
	371	Destroy ceph related data and configuration files.
	372
	373	`--crash` `<boolean>` ::
	374
	375	Additionally purge Ceph crash logs, /var/lib/ceph/crash.
	376
	377	`--logs` `<boolean>` ::
	378
	379	Additionally purge Ceph logs, /var/log/ceph.
	380
	381	pveceph start `[OPTIONS]`
	382
	383	Start ceph services.
	384
	385	`--service` `(ceph\|mon\|mds\|osd\|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
	386
	387	Ceph service name.
	388
	389	pveceph status
	390
	391	Get Ceph Status.
	392
	393	pveceph stop `[OPTIONS]`
	394
	395	Stop ceph services.
	396
	397	`--service` `(ceph\|mon\|mds\|osd\|mgr)(\.[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)?` ('default =' `ceph.target`)::
	398
	399	Ceph service name.
	400
	401