]> git.proxmox.com Git - pve-docs.git/blobdiff - pveceph.1-synopsis.adoc
d/copyright: update years
[pve-docs.git] / pveceph.1-synopsis.adoc
index 9d545577ad3d3451e415a64fba5dc2b2a1329d60..28f48f8f49d11ec58b3bdb583c1a9a4311844d3e 100644 (file)
@@ -48,6 +48,22 @@ The ceph filesystem name.
 
 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.
@@ -102,7 +118,11 @@ Install ceph related packages.
 
 Allow experimental versions. Use with care!
 
-`--version` `<luminous | nautilus | octopus>` ('default =' `nautilus`)::
+`--test-repository` `<boolean>` ('default =' `0`)::
+
+Use the test, not the main repository. Use with care!
+
+`--version` `<octopus | pacific | quincy>` ('default =' `pacific`)::
 
 Ceph version to install.
 
@@ -152,7 +172,7 @@ Create Ceph Monitor and Manager
 
 `--mon-address` `<string>` ::
 
-Overwrites autodetected monitor IP address. Must be in the public network of ceph.
+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])?` ::
 
@@ -182,7 +202,7 @@ Set the device class of the OSD in crush.
 
 Block device name for block.db.
 
-`--db_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
+`--db_dev_size` `<number> (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`)::
 
 Size in GiB for block.db.
 +
@@ -196,7 +216,7 @@ Enables encryption of the OSD.
 
 Block device name for block.wal.
 
-`--wal_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
+`--wal_dev_size` `<number> (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`)::
 
 Size in GiB for block.wal.
 +
@@ -216,13 +236,13 @@ If set, we remove partition table entries.
 
 *pveceph pool create* `<name>` `[OPTIONS]`
 
-Create POOL
+Create Ceph pool
 
 `<name>`: `<string>` ::
 
 The name of the pool. It must be unique.
 
-`--add_storages` `<boolean>` ::
+`--add_storages` `<boolean>` ('default =' `0; for erasure coded pools: 1`)::
 
 Configure VM and CT storage using the new pool.
 
@@ -234,6 +254,10 @@ The application of the pool.
 
 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
@@ -274,13 +298,17 @@ The name of the pool. It must be unique.
 
 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.
+Show the current pool status.
 
 `<name>`: `<string>` ::
 
@@ -292,7 +320,8 @@ If enabled, will display additional data(eg. statistics).
 
 *pveceph pool ls* `[FORMAT_OPTIONS]`
 
-List all pools.
+List all pools and their settings (which are settable by the POST/PUT
+endpoints).
 
 *pveceph pool set* `<name>` `[OPTIONS]`