d/copyright: update years

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

diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc
index 9514e3e62b73f90686bd6391a8d46a6cfde91eb5..28f48f8f49d11ec58b3bdb583c1a9a4311844d3e 100644 (file)
--- a/pveceph.1-synopsis.adoc
+++ b/pveceph.1-synopsis.adoc
@@ -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.
@@ -106,7 +122,7 @@ Allow experimental versions. Use with care!
 
 Use the test, not the main repository. Use with care!
 
-`--version` `<octopus | pacific>` ('default =' `pacific`)::
+`--version` `<octopus | pacific | quincy>` ('default =' `pacific`)::
 
 Ceph version to install.
 
@@ -220,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.
 
@@ -238,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
@@ -278,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>` ::
 
@@ -296,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]`