fixup: s/devies/devices/
[pve-docs.git] / pvesm.1-synopsis.adoc
index 666c39b..5a71906 100644 (file)
@@ -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 | fake | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
 
 Storage type.
 
@@ -58,6 +58,10 @@ NFS export path.
 
 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 +72,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)` ::
 
@@ -94,7 +102,7 @@ disable write caching on the target
 
 NFS mount options (see 'man nfs')
 
-`--password` ::
+`--password` `<password>` ::
 
 Password for CIFS share.
 
@@ -140,14 +148,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 +214,9 @@ no description available
 +
 NOTE: Requires option(s): `size`
 
-*pvesm cifsscan* `<server>` `[OPTIONS]`
-
-Scan remote CIFS server.
-
-`<server>`: `<string>` ::
-
-no description available
-
-`--domain` `<string>` ::
-
-no description available
-
-`--password` ::
+*pvesm cifsscan*
 
-no description available
-
-`--username` `<string>` ::
-
-no description available
+An alias for 'pvesm scan cifs'.
 
 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
 
@@ -270,13 +266,9 @@ Volume identifier
 
 The storage identifier.
 
-*pvesm glusterfsscan* `<server>`
-
-Scan remote GlusterFS server.
-
-`<server>`: `<string>` ::
+*pvesm glusterfsscan*
 
-no description available
+An alias for 'pvesm scan glusterfs'.
 
 *pvesm help* `[OPTIONS]`
 
@@ -318,13 +310,9 @@ A snapshot to delete on success
 
 Whether the stream includes intermediate snapshots
 
-*pvesm iscsiscan* `--portal <string>` `[OPTIONS]`
-
-Scan remote iSCSI server.
-
-`--portal` `<string>` ::
+*pvesm iscsiscan*
 
-no description available
+An alias for 'pvesm scan iscsi'.
 
 *pvesm list* `<storage>` `[OPTIONS]`
 
@@ -344,23 +332,15 @@ Only list images for this VM
 
 *pvesm lvmscan*
 
-List local LVM volume groups.
-
-*pvesm lvmthinscan* `<vg>`
-
-List local LVM Thin Pools.
-
-`<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
+An alias for 'pvesm scan lvm'.
 
-no description available
-
-*pvesm nfsscan* `<server>`
+*pvesm lvmthinscan*
 
-Scan remote NFS server.
+An alias for 'pvesm scan lvmthin'.
 
-`<server>`: `<string>` ::
+*pvesm nfsscan*
 
-no description available
+An alias for 'pvesm scan nfs'.
 
 *pvesm path* `<volume>`
 
@@ -378,6 +358,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.
@@ -428,13 +468,21 @@ CIFS domain.
 
 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)` ::
 
@@ -460,7 +508,7 @@ disable write caching on the target
 
 NFS mount options (see 'man nfs')
 
-`--password` ::
+`--password` `<string>` ::
 
 Password for CIFS share.
 
@@ -494,14 +542,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 +592,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'.