storage: iscsi: don't use links in headers

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

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index 56f697ada3294d05a327c0e388f87dc0895438cc..666c39b44cd9e88dcc9916de849bbe773ebfa13e 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>`: `<cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::

 
 Storage type.
 
 
 Storage type.
 


@@ -12,153 +12,170 @@ Storage type.
 
 The storage identifier.
 
 
 The storage identifier.
 

-`-authsupported` `<string>` ::
+`--authsupported` `<string>` ::

 
 Authsupported.
 
 
 Authsupported.
 

-`-base` `<string>` ::
+`--base` `<string>` ::

 
 Base volume. This volume is automatically activated.
 
 
 Base volume. This volume is automatically activated.
 

-`-blocksize` `<string>` ::
+`--blocksize` `<string>` ::

 
 block size
 
 
 block size
 

-`-comstar_hg` `<string>` ::
+`--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
 
 
 host group for comstar views
 

-`-comstar_tg` `<string>` ::
+`--comstar_tg` `<string>` ::

 
 target group for comstar views
 
 
 target group for comstar views
 

-`-content` `<string>` ::
+`--content` `<string>` ::

 
 Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
 
 Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 

-`-disable` `<boolean>` ::
+`--disable` `<boolean>` ::

 
 Flag to disable the storage.
 
 
 Flag to disable the storage.
 

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

 
 NFS export path.
 
 
 NFS export path.
 

-`-format` `<string>` ::
+`--format` `<string>` ::

 
 Default image format.
 
 
 Default image format.
 

-`-is_mountpoint` `<boolean>` ('default =' `no`)::
+`--is_mountpoint` `<string>` ('default =' `no`)::

 
 

-Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
+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.

 
 

-`-iscsiprovider` `<string>` ::
+`--iscsiprovider` `<string>` ::

 
 iscsi provider
 
 
 iscsi provider
 

-`-krbd` `<boolean>` ::
+`--krbd` `<boolean>` ::

 
 Access rbd through krbd kernel module.
 
 
 Access rbd through krbd kernel module.
 

-`-maxfiles` `<integer> (0 - N)` ::
+`--maxfiles` `<integer> (0 - N)` ::

 
 Maximal number of backup files per VM. Use '0' for unlimted.
 
 
 Maximal number of backup files per VM. Use '0' for unlimted.
 

-`-mkdir` `<boolean>` ('default =' `yes`)::
+`--mkdir` `<boolean>` ('default =' `yes`)::

 
 Create the directory if it doesn't exist.
 
 
 Create the directory if it doesn't exist.
 

-`-monhost` `<string>` ::
+`--monhost` `<string>` ::

 
 

-Monitors daemon ips.
+IP addresses of monitors (for external clusters).

 
 

-`-nodes` `<string>` ::
+`--nodes` `<string>` ::

 
 List of cluster node names.
 
 
 List of cluster node names.
 

-`-nowritecache` `<boolean>` ::
+`--nowritecache` `<boolean>` ::

 
 disable write caching on the target
 
 
 disable write caching on the target
 

-`-options` `<string>` ::
+`--options` `<string>` ::

 
 NFS mount options (see 'man nfs')
 
 
 NFS mount options (see 'man nfs')
 

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

 
 File system path.
 
 
 File system path.
 

-`-pool` `<string>` ::
+`--pool` `<string>` ::

 
 Pool.
 
 
 Pool.
 

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

 
 iSCSI portal (IP or DNS name with optional port).
 
 
 iSCSI portal (IP or DNS name with optional port).
 

-`-redundancy` `<integer> (1 - 16)` ('default =' `2`)::
+`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::

 
 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
 
 
 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
 

-`-saferemove` `<boolean>` ::
+`--saferemove` `<boolean>` ::

 
 Zero-out data when removing LVs.
 
 
 Zero-out data when removing LVs.
 

-`-saferemove_throughput` `<string>` ::
+`--saferemove_throughput` `<string>` ::

 
 Wipe throughput (cstream -t parameter value).
 
 
 Wipe throughput (cstream -t parameter value).
 

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

 
 Server IP or DNS name.
 
 
 Server IP or DNS name.
 

-`-server2` `<string>` ::
+`--server2` `<string>` ::

 
 Backup volfile server IP or DNS name.
 +
 NOTE: Requires option(s): `server`
 
 
 Backup volfile server IP or DNS name.
 +
 NOTE: Requires option(s): `server`
 

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

 
 Mark storage as shared.
 
 
 Mark storage as shared.
 

-`-sparse` `<boolean>` ::
+`--smbversion` `<string>` ::
+
+no description available
+
+`--sparse` `<boolean>` ::

 
 use sparse volumes
 
 
 use sparse volumes
 

-`-tagged_only` `<boolean>` ::
+`--tagged_only` `<boolean>` ::

 
 Only use logical volumes tagged with 'pve-vm-ID'.
 
 
 Only use logical volumes tagged with 'pve-vm-ID'.
 

-`-target` `<string>` ::
+`--target` `<string>` ::

 
 iSCSI target.
 
 
 iSCSI target.
 

-`-thinpool` `<string>` ::
+`--thinpool` `<string>` ::

 
 LVM thin pool LV name.
 
 
 LVM thin pool LV name.
 

-`-transport` `<rdma | tcp | unix>` ::
+`--transport` `<rdma | tcp | unix>` ::

 
 Gluster transport: tcp or rdma
 
 
 Gluster transport: tcp or rdma
 

-`-username` `<string>` ::
+`--username` `<string>` ::

 
 RBD Id.
 
 
 RBD Id.
 

-`-vgname` `<string>` ::
+`--vgname` `<string>` ::

 
 Volume group name.
 
 
 Volume group name.
 

-`-volume` `<string>` ::
+`--volume` `<string>` ::

 
 Glusterfs Volume.
 
 
 Glusterfs Volume.
 

-
-
-

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


@@ -179,40 +196,79 @@ The name of the file to create.
 
 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
 
 
 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
 

-`-format` `<qcow2 | raw | subvol>` ::
+`--format` `<qcow2 | raw | subvol>` ::

 
 no description available
 +
 NOTE: Requires option(s): `size`
 
 
 no description available
 +
 NOTE: Requires option(s): `size`
 

+*pvesm cifsscan* `<server>` `[OPTIONS]`

 
 

+Scan remote CIFS server.

 
 

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

 
 

-*pvesm extractconfig* `<volume>`
+no description available

 
 

-Extract configuration from vzdump backup archive.
+`--domain` `<string>` ::
+
+no description available
+
+`--password` ::
+
+no description available
+
+`--username` `<string>` ::
+
+no description available
+
+*pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
+
+Export a volume.

 
 `<volume>`: `<string>` ::
 
 Volume identifier
 
 
 `<volume>`: `<string>` ::
 
 Volume identifier
 

+`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::

 
 

+Export stream format

 
 

+`<filename>`: `<string>` ::

 
 

-*pvesm free* `<volume>` `[OPTIONS]`
+Destination file name

 
 

-Delete volume
+`--base` `(?^:[a-z0-9_\-]{1,40})` ::
+
+Snapshot to start an incremental stream from
+
+`--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
+
+Snapshot to export
+
+`--with-snapshots` `<boolean>` ('default =' `0`)::
+
+Whether to include intermediate snapshots in the stream
+
+*pvesm extractconfig* `<volume>`
+
+Extract configuration from vzdump backup archive.

 
 `<volume>`: `<string>` ::
 
 Volume identifier
 
 
 `<volume>`: `<string>` ::
 
 Volume identifier
 

-`-storage` `<string>` ::
+*pvesm free* `<volume>` `[OPTIONS]`
+
+Delete volume

 
 

-The storage identifier.
+`<volume>`: `<string>` ::

 
 

+Volume identifier

 
 

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

 
 

+The storage identifier.

 
 *pvesm glusterfsscan* `<server>`
 
 
 *pvesm glusterfsscan* `<server>`
 


@@ -222,34 +278,53 @@ Scan remote GlusterFS server.
 
 no description available
 
 
 no description available
 

+*pvesm help* `[OPTIONS]`

 
 

+Get help about specified command.

 
 

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

 
 

-*pvesm help* `[<cmd>]` `[OPTIONS]`
+Shows help for a specific command

 
 

-Get help about specified command.
+`--verbose` `<boolean>` ::

 
 

-`<cmd>`: `<string>` ::
+Verbose output format.

 
 

-Command name
+*pvesm import* `<volume> <format> <filename>` `[OPTIONS]`

 
 

-`-verbose` `<boolean>` ::
+Import a volume.

 
 

-Verbose output format.
+`<volume>`: `<string>` ::

 
 

+Volume identifier

 
 

+`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::

 
 

+Import stream format

 
 

-*pvesm iscsiscan* `-portal <string>` `[OPTIONS]`
+`<filename>`: `<string>` ::

 
 

-Scan remote iSCSI server.
+Source file name

 
 

-`-portal` `<string>` ::
+`--base` `(?^:[a-z0-9_\-]{1,40})` ::

 
 

-no description available
+Base snapshot of an incremental stream
+
+`--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::

 
 

+A snapshot to delete on success

 
 

+`--with-snapshots` `<boolean>` ('default =' `0`)::

 
 

+Whether the stream includes intermediate snapshots
+
+*pvesm iscsiscan* `--portal <string>` `[OPTIONS]`
+
+Scan remote iSCSI server.
+
+`--portal` `<string>` ::
+
+no description available

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


@@ -259,23 +334,18 @@ List storage content.
 
 The storage identifier.
 
 
 The storage identifier.
 

-`-content` `<string>` ::
+`--content` `<string>` ::

 
 Only list content of this type.
 
 
 Only list content of this type.
 

-`-vmid` `<integer> (1 - N)` ::
+`--vmid` `<integer> (1 - N)` ::

 
 Only list images for this VM
 
 
 Only list images for this VM
 

-
-
-

 *pvesm lvmscan*
 
 List local LVM volume groups.
 
 *pvesm lvmscan*
 
 List local LVM volume groups.
 

-
-

 *pvesm lvmthinscan* `<vg>`
 
 List local LVM Thin Pools.
 *pvesm lvmthinscan* `<vg>`
 
 List local LVM Thin Pools.


@@ -284,8 +354,6 @@ List local LVM Thin Pools.
 
 no description available
 
 
 no description available
 

-
-

 *pvesm nfsscan* `<server>`
 
 Scan remote NFS server.
 *pvesm nfsscan* `<server>`
 
 Scan remote NFS server.


@@ -294,9 +362,6 @@ Scan remote NFS server.
 
 no description available
 
 
 no description available
 

-
-
-

 *pvesm path* `<volume>`
 
 Get filesystem path for specified volume
 *pvesm path* `<volume>`
 
 Get filesystem path for specified volume


@@ -305,9 +370,6 @@ Get filesystem path for specified volume
 
 Volume identifier
 
 
 Volume identifier
 

-
-
-

 *pvesm remove* `<storage>`
 
 Delete storage configuration.
 *pvesm remove* `<storage>`
 
 Delete storage configuration.


@@ -316,8 +378,6 @@ Delete storage configuration.
 
 The storage identifier.
 
 
 The storage identifier.
 

-
-

 *pvesm set* `<storage>` `[OPTIONS]`
 
 Update storage configuration.
 *pvesm set* `<storage>` `[OPTIONS]`
 
 Update storage configuration.


@@ -326,144 +386,160 @@ Update storage configuration.
 
 The storage identifier.
 
 
 The storage identifier.
 

-`-blocksize` `<string>` ::
+`--blocksize` `<string>` ::

 
 block size
 
 
 block size
 

-`-comstar_hg` `<string>` ::
+`--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
 
 
 host group for comstar views
 

-`-comstar_tg` `<string>` ::
+`--comstar_tg` `<string>` ::

 
 target group for comstar views
 
 
 target group for comstar views
 

-`-content` `<string>` ::
+`--content` `<string>` ::

 
 Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
 
 Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 

-`-delete` `<string>` ::
+`--delete` `<string>` ::

 
 A list of settings you want to delete.
 
 
 A list of settings you want to delete.
 

-`-digest` `<string>` ::
+`--digest` `<string>` ::

 
 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 
 
 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 

-`-disable` `<boolean>` ::
+`--disable` `<boolean>` ::

 
 Flag to disable the storage.
 
 
 Flag to disable the storage.
 

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

 
 Default image format.
 
 
 Default image format.
 

-`-is_mountpoint` `<boolean>` ('default =' `no`)::
+`--is_mountpoint` `<string>` ('default =' `no`)::

 
 

-Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
+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>` ::
+`--krbd` `<boolean>` ::

 
 Access rbd through krbd kernel module.
 
 
 Access rbd through krbd kernel module.
 

-`-maxfiles` `<integer> (0 - N)` ::
+`--maxfiles` `<integer> (0 - N)` ::

 
 Maximal number of backup files per VM. Use '0' for unlimted.
 
 
 Maximal number of backup files per VM. Use '0' for unlimted.
 

-`-mkdir` `<boolean>` ('default =' `yes`)::
+`--mkdir` `<boolean>` ('default =' `yes`)::

 
 Create the directory if it doesn't exist.
 
 
 Create the directory if it doesn't exist.
 

-`-nodes` `<string>` ::
+`--monhost` `<string>` ::
+
+IP addresses of monitors (for external clusters).
+
+`--nodes` `<string>` ::

 
 List of cluster node names.
 
 
 List of cluster node names.
 

-`-nowritecache` `<boolean>` ::
+`--nowritecache` `<boolean>` ::

 
 disable write caching on the target
 
 
 disable write caching on the target
 

-`-options` `<string>` ::
+`--options` `<string>` ::

 
 NFS mount options (see 'man nfs')
 
 
 NFS mount options (see 'man nfs')
 

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

 
 Pool.
 
 
 Pool.
 

-`-redundancy` `<integer> (1 - 16)` ('default =' `2`)::
+`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::

 
 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
 
 
 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
 

-`-saferemove` `<boolean>` ::
+`--saferemove` `<boolean>` ::

 
 Zero-out data when removing LVs.
 
 
 Zero-out data when removing LVs.
 

-`-saferemove_throughput` `<string>` ::
+`--saferemove_throughput` `<string>` ::

 
 Wipe throughput (cstream -t parameter value).
 
 
 Wipe throughput (cstream -t parameter value).
 

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

 
 Server IP or DNS name.
 
 
 Server IP or DNS name.
 

-`-server2` `<string>` ::
+`--server2` `<string>` ::

 
 Backup volfile server IP or DNS name.
 +
 NOTE: Requires option(s): `server`
 
 
 Backup volfile server IP or DNS name.
 +
 NOTE: Requires option(s): `server`
 

-`-shared` `<boolean>` ::
+`--shared` `<boolean>` ::

 
 Mark storage as shared.
 
 
 Mark storage as shared.
 

-`-sparse` `<boolean>` ::
+`--smbversion` `<string>` ::
+
+no description available
+
+`--sparse` `<boolean>` ::

 
 use sparse volumes
 
 
 use sparse volumes
 

-`-tagged_only` `<boolean>` ::
+`--tagged_only` `<boolean>` ::

 
 Only use logical volumes tagged with 'pve-vm-ID'.
 
 
 Only use logical volumes tagged with 'pve-vm-ID'.
 

-`-transport` `<rdma | tcp | unix>` ::
+`--transport` `<rdma | tcp | unix>` ::

 
 Gluster transport: tcp or rdma
 
 
 Gluster transport: tcp or rdma
 

-`-username` `<string>` ::
+`--username` `<string>` ::

 
 RBD Id.
 
 
 RBD Id.
 

-
-
-

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

-`-content` `<string>` ::
+`--content` `<string>` ::

 
 Only list stores which support this content type.
 
 
 Only list stores which support this content type.
 

-`-enabled` `<boolean>` ('default =' `0`)::
+`--enabled` `<boolean>` ('default =' `0`)::

 
 Only list stores which are enabled (not disabled in config).
 
 
 Only list stores which are enabled (not disabled in config).
 

-`-storage` `<string>` ::
-
-Only list status for  specified storage
+`--format` `<boolean>` ('default =' `0`)::

 
 

-`-target` `<string>` ::
+Include information about formats

 
 

-If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
+`--storage` `<string>` ::

 
 

+Only list status for  specified storage

 
 

+`--target` `<string>` ::

 
 

+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*
 
 Scan zfs pool list on local node.
 
 
 
 *pvesm zfsscan*
 
 Scan zfs pool list on local node.
 
 

-
-