fixup: s/devies/devices/

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

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index 326c6038218ee93ee7475f86c771574d377b34dc..5a71906311410773811026056d8fab464ad89d78 100644 (file)
--- a/pvesm.1-synopsis.adoc
+++ b/pvesm.1-synopsis.adoc
@@ -4,7 +4,7 @@
 
 Create a new storage.
 
 
 Create a new storage.
 

-`<type>`: `<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.
 
 
 Storage type.
 


@@ -24,6 +24,10 @@ Base volume. This volume is automatically activated.
 
 block size
 
 
 block size
 

+`--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
+
+Set bandwidth/io limits various operations.
+

 `--comstar_hg` `<string>` ::
 
 host group for comstar views
 `--comstar_hg` `<string>` ::
 
 host group for comstar views


@@ -42,6 +46,10 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
 Flag to disable the storage.
 
 
 Flag to disable the storage.
 

+`--domain` `<string>` ::
+
+CIFS domain.
+

 `--export` `<string>` ::
 
 NFS export path.
 `--export` `<string>` ::
 
 NFS export path.


@@ -50,6 +58,10 @@ NFS export path.
 
 Default image format.
 
 
 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.
 `--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.


@@ -60,7 +72,11 @@ iscsi provider
 
 `--krbd` `<boolean>` ::
 
 
 `--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)` ::
 
 
 `--maxfiles` `<integer> (0 - N)` ::
 


@@ -86,6 +102,10 @@ disable write caching on the target
 
 NFS mount options (see 'man nfs')
 
 
 NFS mount options (see 'man nfs')
 

+`--password` `<password>` ::
+
+Password for CIFS share.
+

 `--path` `<string>` ::
 
 File system path.
 `--path` `<string>` ::
 
 File system path.


@@ -120,14 +140,26 @@ Backup volfile server IP or DNS name.
 +
 NOTE: Requires option(s): `server`
 
 +
 NOTE: Requires option(s): `server`
 

+`--share` `<string>` ::
+
+CIFS share.
+

 `--shared` `<boolean>` ::
 
 Mark storage as shared.
 
 `--shared` `<boolean>` ::
 
 Mark storage as shared.
 

+`--smbversion` `<2.0 | 2.1 | 3.0>` ::
+
+SMB protocol version
+

 `--sparse` `<boolean>` ::
 
 use sparse volumes
 
 `--sparse` `<boolean>` ::
 
 use sparse volumes
 

+`--subdir` `<string>` ::
+
+Subdir to mount.
+

 `--tagged_only` `<boolean>` ::
 
 Only use logical volumes tagged with 'pve-vm-ID'.
 `--tagged_only` `<boolean>` ::
 
 Only use logical volumes tagged with 'pve-vm-ID'.


@@ -156,9 +188,6 @@ Volume group name.
 
 Glusterfs Volume.
 
 
 Glusterfs Volume.
 

-
-
-

 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
 
 Allocate disk images.
 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
 
 Allocate disk images.


@@ -185,8 +214,9 @@ no description available
 +
 NOTE: Requires option(s): `size`
 
 +
 NOTE: Requires option(s): `size`
 

+*pvesm cifsscan*

 
 

-
+An alias for 'pvesm scan cifs'.

 
 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
 
 
 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
 


@@ -216,8 +246,6 @@ Snapshot to export
 
 Whether to include intermediate snapshots in the stream
 
 
 Whether to include intermediate snapshots in the stream
 

-
-

 *pvesm extractconfig* `<volume>`
 
 Extract configuration from vzdump backup archive.
 *pvesm extractconfig* `<volume>`
 
 Extract configuration from vzdump backup archive.


@@ -226,9 +254,6 @@ Extract configuration from vzdump backup archive.
 
 Volume identifier
 
 
 Volume identifier
 

-
-
-

 *pvesm free* `<volume>` `[OPTIONS]`
 
 Delete volume
 *pvesm free* `<volume>` `[OPTIONS]`
 
 Delete volume


@@ -241,35 +266,22 @@ Volume identifier
 
 The storage identifier.
 
 
 The storage identifier.
 

+*pvesm glusterfsscan*

 
 

+An alias for 'pvesm scan glusterfs'.

 
 

-
-*pvesm glusterfsscan* `<server>`
-
-Scan remote GlusterFS server.
-
-`<server>`: `<string>` ::
-
-no description available
-
-
-
-
-*pvesm help* `[<cmd>]` `[OPTIONS]`
+*pvesm help* `[OPTIONS]`

 
 Get help about specified command.
 
 
 Get help about specified command.
 

-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::

 
 

-Command name
+Shows help for a specific command

 
 `--verbose` `<boolean>` ::
 
 Verbose output format.
 
 
 `--verbose` `<boolean>` ::
 
 Verbose output format.
 

-
-
-

 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
 
 Import a volume.
 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
 
 Import a volume.


@@ -298,19 +310,9 @@ A snapshot to delete on success
 
 Whether the stream includes intermediate snapshots
 
 
 Whether the stream includes intermediate snapshots
 

+*pvesm iscsiscan*

 
 

-
-
-*pvesm iscsiscan* `--portal <string>` `[OPTIONS]`
-
-Scan remote iSCSI server.
-
-`--portal` `<string>` ::
-
-no description available
-
-
-
+An alias for 'pvesm scan iscsi'.

 
 *pvesm list* `<storage>` `[OPTIONS]`
 
 
 *pvesm list* `<storage>` `[OPTIONS]`
 


@@ -328,56 +330,93 @@ Only list content of this type.
 
 Only list images for this VM
 
 
 Only list images for this VM
 

+*pvesm lvmscan*

 
 

+An alias for 'pvesm scan lvm'.

 
 

+*pvesm lvmthinscan*

 
 

-*pvesm lvmscan*
+An alias for 'pvesm scan lvmthin'.

 
 

-List local LVM volume groups.
+*pvesm nfsscan*

 
 

+An alias for 'pvesm scan nfs'.

 
 

+*pvesm path* `<volume>`

 
 

-*pvesm lvmthinscan* `<vg>`
+Get filesystem path for specified volume

 
 

-List local LVM Thin Pools.
+`<volume>`: `<string>` ::

 
 

-`<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
+Volume identifier

 
 

-no description available
+*pvesm remove* `<storage>`

 
 

+Delete storage configuration.

 
 

+`<storage>`: `<string>` ::

 
 

-*pvesm nfsscan* `<server>`
+The storage identifier.

 
 

-Scan remote NFS server.
+*pvesm scan cifs* `<server>` `[OPTIONS]`
+
+Scan remote CIFS server.

 
 `<server>`: `<string>` ::
 
 
 `<server>`: `<string>` ::
 

-no description available
+The server address (name or IP).

 
 

+`--domain` `<string>` ::

 
 

+SMB domain (Workgroup).

 
 

+`--password` `<password>` ::

 
 

-*pvesm path* `<volume>`
+User password.

 
 

-Get filesystem path for specified volume
+`--username` `<string>` ::

 
 

-`<volume>`: `<string>` ::
+User name.

 
 

-Volume identifier
+*pvesm scan glusterfs* `<server>`

 
 

+Scan remote GlusterFS server.

 
 

+`<server>`: `<string>` ::

 
 

+The server address (name or IP).

 
 

-*pvesm remove* `<storage>`
+*pvesm scan iscsi* `<portal>`

 
 

-Delete storage configuration.
+Scan remote iSCSI server.

 
 

-`<storage>`: `<string>` ::
+`<portal>`: `<string>` ::

 
 

-The storage identifier.
+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]`
 
 
 *pvesm set* `<storage>` `[OPTIONS]`
 


@@ -391,6 +430,10 @@ The storage identifier.
 
 block size
 
 
 block size
 

+`--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
+
+Set bandwidth/io limits various operations.
+

 `--comstar_hg` `<string>` ::
 
 host group for comstar views
 `--comstar_hg` `<string>` ::
 
 host group for comstar views


@@ -417,17 +460,29 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
 
 Flag to disable the storage.
 
 
 Flag to disable the storage.
 

+`--domain` `<string>` ::
+
+CIFS domain.
+

 `--format` `<string>` ::
 
 Default image format.
 
 `--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>` ::
 
 `--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)` ::
 
 
 `--maxfiles` `<integer> (0 - N)` ::
 


@@ -453,6 +508,10 @@ disable write caching on the target
 
 NFS mount options (see 'man nfs')
 
 
 NFS mount options (see 'man nfs')
 

+`--password` `<string>` ::
+
+Password for CIFS share.
+

 `--pool` `<string>` ::
 
 Pool.
 `--pool` `<string>` ::
 
 Pool.


@@ -483,10 +542,18 @@ NOTE: Requires option(s): `server`
 
 Mark storage as shared.
 
 
 Mark storage as shared.
 

+`--smbversion` `<2.0 | 2.1 | 3.0>` ::
+
+SMB protocol version
+

 `--sparse` `<boolean>` ::
 
 use sparse volumes
 
 `--sparse` `<boolean>` ::
 
 use sparse volumes
 

+`--subdir` `<string>` ::
+
+Subdir to mount.
+

 `--tagged_only` `<boolean>` ::
 
 Only use logical volumes tagged with 'pve-vm-ID'.
 `--tagged_only` `<boolean>` ::
 
 Only use logical volumes tagged with 'pve-vm-ID'.


@@ -499,9 +566,6 @@ Gluster transport: tcp or rdma
 
 RBD Id.
 
 
 RBD Id.
 

-
-
-

 *pvesm status* `[OPTIONS]`
 
 Get status for all datastores.
 *pvesm status* `[OPTIONS]`
 
 Get status for all datastores.


@@ -514,6 +578,10 @@ Only list stores which support this content type.
 
 Only list stores which are enabled (not disabled in config).
 
 
 Only list stores which are enabled (not disabled in config).
 

+`--format` `<boolean>` ('default =' `0`)::
+
+Include information about formats
+

 `--storage` `<string>` ::
 
 Only list status for  specified storage
 `--storage` `<string>` ::
 
 Only list status for  specified storage


@@ -522,13 +590,8 @@ Only list status for  specified storage
 
 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
 
 
 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
 

-
-
-

 *pvesm zfsscan*
 
 *pvesm zfsscan*
 

-Scan zfs pool list on local node.
-
-
+An alias for 'pvesm scan zfs'.