storage: make description column wider

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

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index 666c39b44cd9e88dcc9916de849bbe773ebfa13e..930b4a9ea06d616509a36242fc4a5cbd0963a299 100644 (file)
--- a/pvesm.1-synopsis.adoc
+++ b/pvesm.1-synopsis.adoc
@@ -4,7 +4,7 @@
 
 Create a new storage.
 
-`<type>`: `<cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
+`<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` ::
 
 Storage type.
 
@@ -42,6 +42,10 @@ Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
+`--datastore` `<string>` ::
+
+Proxmox backup server datastore name.
+
 `--disable` `<boolean>` ::
 
 Flag to disable the storage.
@@ -54,10 +58,18 @@ CIFS domain.
 
 NFS export path.
 
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
+
+Certificate SHA 256 fingerprint.
+
 `--format` `<string>` ::
 
 Default image format.
 
+`--fuse` `<boolean>` ::
+
+Mount CephFS through FUSE.
+
 `--is_mountpoint` `<string>` ('default =' `no`)::
 
 Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.
@@ -68,7 +80,11 @@ iscsi provider
 
 `--krbd` `<boolean>` ::
 
-Access rbd through krbd kernel module.
+Always access rbd through krbd kernel module.
+
+`--lio_tpg` `<string>` ::
+
+target portal group for Linux LIO targets
 
 `--maxfiles` `<integer> (0 - N)` ::
 
@@ -82,6 +98,10 @@ Create the directory if it doesn't exist.
 
 IP addresses of monitors (for external clusters).
 
+`--mountpoint` `<string>` ::
+
+mount point
+
 `--nodes` `<string>` ::
 
 List of cluster node names.
@@ -94,7 +114,7 @@ disable write caching on the target
 
 NFS mount options (see 'man nfs')
 
-`--password` ::
+`--password` `<password>` ::
 
 Password for CIFS share.
 
@@ -140,14 +160,18 @@ CIFS share.
 
 Mark storage as shared.
 
-`--smbversion` `<string>` ::
+`--smbversion` `<2.0 | 2.1 | 3.0>` ::
 
-no description available
+SMB protocol version
 
 `--sparse` `<boolean>` ::
 
 use sparse volumes
 
+`--subdir` `<string>` ::
+
+Subdir to mount.
+
 `--tagged_only` `<boolean>` ::
 
 Only use logical volumes tagged with 'pve-vm-ID'.
@@ -202,25 +226,13 @@ no description available
 +
 NOTE: Requires option(s): `size`
 
-*pvesm cifsscan* `<server>` `[OPTIONS]`
+*pvesm apiinfo*
 
-Scan remote CIFS server.
+Returns APIVER and APIAGE.
 
-`<server>`: `<string>` ::
-
-no description available
-
-`--domain` `<string>` ::
-
-no description available
+*pvesm cifsscan*
 
-`--password` ::
-
-no description available
-
-`--username` `<string>` ::
-
-no description available
+An alias for 'pvesm scan cifs'.
 
 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
 
@@ -266,17 +278,17 @@ Delete volume
 
 Volume identifier
 
-`--storage` `<string>` ::
+`--delay` `<integer> (1 - 30)` ::
 
-The storage identifier.
+Time to wait for the task to finish. We return 'null' if the task finish within that time.
 
-*pvesm glusterfsscan* `<server>`
+`--storage` `<string>` ::
 
-Scan remote GlusterFS server.
+The storage identifier.
 
-`<server>`: `<string>` ::
+*pvesm glusterfsscan*
 
-no description available
+An alias for 'pvesm scan glusterfs'.
 
 *pvesm help* `[OPTIONS]`
 
@@ -304,7 +316,11 @@ Import stream format
 
 `<filename>`: `<string>` ::
 
-Source file name
+Source file name. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection as input. Else, the file is treated as common file.
+
+`--allow-rename` `<boolean>` ('default =' `0`)::
+
+Choose a new volume ID if the requested volume ID already exists, instead of throwing an error.
 
 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
 
@@ -318,13 +334,9 @@ A snapshot to delete on success
 
 Whether the stream includes intermediate snapshots
 
-*pvesm iscsiscan* `--portal <string>` `[OPTIONS]`
-
-Scan remote iSCSI server.
+*pvesm iscsiscan*
 
-`--portal` `<string>` ::
-
-no description available
+An alias for 'pvesm scan iscsi'.
 
 *pvesm list* `<storage>` `[OPTIONS]`
 
@@ -344,23 +356,15 @@ Only list images for this VM
 
 *pvesm lvmscan*
 
-List local LVM volume groups.
+An alias for 'pvesm scan lvm'.
 
-*pvesm lvmthinscan* `<vg>`
+*pvesm lvmthinscan*
 
-List local LVM Thin Pools.
+An alias for 'pvesm scan lvmthin'.
 
-`<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
+*pvesm nfsscan*
 
-no description available
-
-*pvesm nfsscan* `<server>`
-
-Scan remote NFS server.
-
-`<server>`: `<string>` ::
-
-no description available
+An alias for 'pvesm scan nfs'.
 
 *pvesm path* `<volume>`
 
@@ -378,6 +382,66 @@ Delete storage configuration.
 
 The storage identifier.
 
+*pvesm scan cifs* `<server>` `[OPTIONS]`
+
+Scan remote CIFS server.
+
+`<server>`: `<string>` ::
+
+The server address (name or IP).
+
+`--domain` `<string>` ::
+
+SMB domain (Workgroup).
+
+`--password` `<password>` ::
+
+User password.
+
+`--username` `<string>` ::
+
+User name.
+
+*pvesm scan glusterfs* `<server>`
+
+Scan remote GlusterFS server.
+
+`<server>`: `<string>` ::
+
+The server address (name or IP).
+
+*pvesm scan iscsi* `<portal>`
+
+Scan remote iSCSI server.
+
+`<portal>`: `<string>` ::
+
+The iSCSI portal (IP or DNS name with optional port).
+
+*pvesm scan lvm*
+
+List local LVM volume groups.
+
+*pvesm scan lvmthin* `<vg>`
+
+List local LVM Thin Pools.
+
+`<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
+
+no description available
+
+*pvesm scan nfs* `<server>`
+
+Scan remote NFS server.
+
+`<server>`: `<string>` ::
+
+The server address (name or IP).
+
+*pvesm scan zfs*
+
+Scan zfs pool list on local node.
+
 *pvesm set* `<storage>` `[OPTIONS]`
 
 Update storage configuration.
@@ -424,17 +488,29 @@ Flag to disable the storage.
 
 CIFS domain.
 
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
+
+Certificate SHA 256 fingerprint.
+
 `--format` `<string>` ::
 
 Default image format.
 
+`--fuse` `<boolean>` ::
+
+Mount CephFS through FUSE.
+
 `--is_mountpoint` `<string>` ('default =' `no`)::
 
 Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.
 
 `--krbd` `<boolean>` ::
 
-Access rbd through krbd kernel module.
+Always access rbd through krbd kernel module.
+
+`--lio_tpg` `<string>` ::
+
+target portal group for Linux LIO targets
 
 `--maxfiles` `<integer> (0 - N)` ::
 
@@ -448,6 +524,10 @@ Create the directory if it doesn't exist.
 
 IP addresses of monitors (for external clusters).
 
+`--mountpoint` `<string>` ::
+
+mount point
+
 `--nodes` `<string>` ::
 
 List of cluster node names.
@@ -460,7 +540,7 @@ disable write caching on the target
 
 NFS mount options (see 'man nfs')
 
-`--password` ::
+`--password` `<string>` ::
 
 Password for CIFS share.
 
@@ -494,14 +574,18 @@ NOTE: Requires option(s): `server`
 
 Mark storage as shared.
 
-`--smbversion` `<string>` ::
+`--smbversion` `<2.0 | 2.1 | 3.0>` ::
 
-no description available
+SMB protocol version
 
 `--sparse` `<boolean>` ::
 
 use sparse volumes
 
+`--subdir` `<string>` ::
+
+Subdir to mount.
+
 `--tagged_only` `<boolean>` ::
 
 Only use logical volumes tagged with 'pve-vm-ID'.
@@ -540,6 +624,6 @@ If target is different to 'node', we only lists shared storages which content is
 
 *pvesm zfsscan*
 
-Scan zfs pool list on local node.
+An alias for 'pvesm scan zfs'.