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 1798c3bd17abd8f16f8b23ec9208f9416649064a..12f450138301dd2741abc5a142dc0dc0a0095ed0 100644 (file)
--- a/pveceph.1-synopsis.adoc
+++ b/pveceph.1-synopsis.adoc
@@ -104,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`)::
 
@@ -118,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.
 
@@ -212,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.
@@ -234,6 +239,18 @@ 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 Ceph pool
@@ -256,7 +273,7 @@ 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.
+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`)::
 
@@ -308,7 +325,7 @@ 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>` ::
 
@@ -320,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]`