fix #5429: network: override device names: include Type=ether

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

diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc
index 9514e3e62b73f90686bd6391a8d46a6cfde91eb5..12f450138301dd2741abc5a142dc0dc0a0095ed0 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.
@@ -88,7 +104,7 @@ Use specific network for all ceph related traffic
 
 Placement group bits, used to specify the default number of placement groups.
 +
-NOTE: 'osd pool default pg num' does not work for default pools.
+Depreacted. This setting was deprecated in recent Ceph versions.
 
 `--size` `<integer> (1 - 7)` ('default =' `3`)::
 
@@ -102,11 +118,11 @@ Install ceph related packages.
 
 Allow experimental versions. Use with care!
 
-`--test-repository` `<boolean>` ('default =' `0`)::
+`--repository` `<enterprise | no-subscription | test>` ('default =' `enterprise`)::
 
-Use the test, not the main repository. Use with care!
+Ceph repository to use.
 
-`--version` `<octopus | pacific>` ('default =' `pacific`)::
+`--version` `<quincy | reef>` ('default =' `quincy`)::
 
 Ceph version to install.
 
@@ -196,6 +212,11 @@ NOTE: Requires option(s): `db_dev`
 
 Enables encryption of the OSD.
 
+`--osds-per-device` `<integer> (1 - N)` ::
+
+OSD services per physical device. Only useful for fast NVMe devices"
+                   ." to utilize their performance better.
+
 `--wal_dev` `<string>` ::
 
 Block device name for block.wal.
@@ -218,15 +239,27 @@ OSD ID
 
 If set, we remove partition table entries.
 
+*pveceph osd details* `<osdid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Get OSD details.
+
+`<osdid>`: `<string>` ::
+
+ID of the OSD
+
+`--verbose` `<boolean>` ('default =' `0`)::
+
+Print verbose information, same as json-pretty output format.
+
 *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 +271,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 +315,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 +337,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]`