network: override device names: suggest running update-initramfs

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

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index 89c797b78eb0824d5f4ac0c71ee496712cd669d5..e5f885f21f726e003e83ccea2f5a43161865d03d 100644 (file)
--- a/pvesm.1-synopsis.adoc
+++ b/pvesm.1-synopsis.adoc
@@ -4,11 +4,11 @@
 
 Create a new storage.
 
 
 Create a new storage.
 

-`<type>`: `<btrfs | cephfs | cifs | dir | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` ::
+`<type>`: `<btrfs | cephfs | cifs | dir | esxi | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` ::

 
 Storage type.
 
 
 Storage type.
 

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

 
 The storage identifier.
 
 
 The storage identifier.
 


@@ -26,7 +26,7 @@ block size
 
 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
 
 
 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
 

-Set bandwidth/io limits various operations.
+Set I/O bandwidth limit for various operations (in KiB/s).

 
 `--comstar_hg` `<string>` ::
 
 
 `--comstar_hg` `<string>` ::
 


@@ -42,6 +42,18 @@ Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 

+`--content-dirs` `<string>` ::
+
+Overrides for default content type directories.
+
+`--create-base-path` `<boolean>` ('default =' `yes`)::
+
+Create the base directory if it doesn't exist.
+
+`--create-subdirs` `<boolean>` ('default =' `yes`)::
+
+Populate the directory with the default structure.
+

 `--data-pool` `<string>` ::
 
 Data Pool (for erasure coding only)
 `--data-pool` `<string>` ::
 
 Data Pool (for erasure coding only)


@@ -116,7 +128,7 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM.
 
 `--mkdir` `<boolean>` ('default =' `yes`)::
 
 
 `--mkdir` `<boolean>` ('default =' `yes`)::
 

-Create the directory if it doesn't exist.
+Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.

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


@@ -136,7 +148,7 @@ Set the NOCOW flag on files. Disables data checksumming and causes data errors t
 
 `--nodes` `<string>` ::
 
 
 `--nodes` `<string>` ::
 

-List of cluster node names.
+List of nodes for which the storage configuration applies.

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


@@ -144,7 +156,7 @@ disable write caching on the target
 
 `--options` `<string>` ::
 
 
 `--options` `<string>` ::
 

-NFS mount options (see 'man nfs')
+NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')

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


@@ -158,7 +170,7 @@ File system path.
 
 Pool.
 
 
 Pool.
 

-`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+`--port` `<integer> (1 - 65535)` ::

 
 For non default port.
 
 
 For non default port.
 


@@ -198,7 +210,11 @@ CIFS share.
 
 `--shared` `<boolean>` ::
 
 
 `--shared` `<boolean>` ::
 

-Mark storage as shared.
+Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such!
+
+`--skip-cert-verification` `<boolean>` ('default =' `false`)::
+
+Disable TLS certificate verification, only enable on fully trusted networks!

 
 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
 
 
 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
 


@@ -244,11 +260,11 @@ Glusterfs Volume.
 
 Allocate disk images.
 
 
 Allocate disk images.
 

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

 
 The storage identifier.
 
 
 The storage identifier.
 

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

 
 Specify owner VM
 
 
 Specify owner VM
 


@@ -326,7 +342,7 @@ Volume identifier
 
 Time to wait for the task to finish. We return 'null' if the task finish within that time.
 
 
 Time to wait for the task to finish. We return 'null' if the task finish within that time.
 

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

 
 The storage identifier.
 
 
 The storage identifier.
 


@@ -390,7 +406,7 @@ An alias for 'pvesm scan iscsi'.
 
 List storage content.
 
 
 List storage content.
 

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

 
 The storage identifier.
 
 
 The storage identifier.
 


@@ -398,7 +414,7 @@ The storage identifier.
 
 Only list content of this type.
 
 
 Only list content of this type.
 

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

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


@@ -428,7 +444,7 @@ Prune backups. Only those using the standard naming scheme are considered.
 If no keep options are specified, those from the storage configuration are
 used.
 
 If no keep options are specified, those from the storage configuration are
 used.
 

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

 
 The storage identifier.
 
 
 The storage identifier.
 


@@ -468,7 +484,7 @@ Keep backups for the last <N> different years. If there is morethan one backup f
 
 Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
 
 
 Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
 

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

 
 Only consider backups for this guest.
 
 
 Only consider backups for this guest.
 


@@ -476,7 +492,7 @@ Only consider backups for this guest.
 
 Delete storage configuration.
 
 
 Delete storage configuration.
 

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

 
 The storage identifier.
 
 
 The storage identifier.
 


@@ -568,7 +584,7 @@ Scan zfs pool list on local node.
 
 Update storage configuration.
 
 
 Update storage configuration.
 

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

 
 The storage identifier.
 
 
 The storage identifier.
 


@@ -578,7 +594,7 @@ block size
 
 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
 
 
 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
 

-Set bandwidth/io limits various operations.
+Set I/O bandwidth limit for various operations (in KiB/s).

 
 `--comstar_hg` `<string>` ::
 
 
 `--comstar_hg` `<string>` ::
 


@@ -594,6 +610,18 @@ Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 

+`--content-dirs` `<string>` ::
+
+Overrides for default content type directories.
+
+`--create-base-path` `<boolean>` ('default =' `yes`)::
+
+Create the base directory if it doesn't exist.
+
+`--create-subdirs` `<boolean>` ('default =' `yes`)::
+
+Populate the directory with the default structure.
+

 `--data-pool` `<string>` ::
 
 Data Pool (for erasure coding only)
 `--data-pool` `<string>` ::
 
 Data Pool (for erasure coding only)


@@ -604,7 +632,7 @@ 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 a different digest. This can be used to prevent concurrent modifications.

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


@@ -664,7 +692,7 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM.
 
 `--mkdir` `<boolean>` ('default =' `yes`)::
 
 
 `--mkdir` `<boolean>` ('default =' `yes`)::
 

-Create the directory if it doesn't exist.
+Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.

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


@@ -684,7 +712,7 @@ Set the NOCOW flag on files. Disables data checksumming and causes data errors t
 
 `--nodes` `<string>` ::
 
 
 `--nodes` `<string>` ::
 

-List of cluster node names.
+List of nodes for which the storage configuration applies.

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


@@ -692,7 +720,7 @@ disable write caching on the target
 
 `--options` `<string>` ::
 
 
 `--options` `<string>` ::
 

-NFS mount options (see 'man nfs')
+NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')

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


@@ -702,7 +730,7 @@ Password for accessing the share/datastore.
 
 Pool.
 
 
 Pool.
 

-`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+`--port` `<integer> (1 - 65535)` ::

 
 For non default port.
 
 
 For non default port.
 


@@ -734,7 +762,11 @@ NOTE: Requires option(s): `server`
 
 `--shared` `<boolean>` ::
 
 
 `--shared` `<boolean>` ::
 

-Mark storage as shared.
+Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such!
+
+`--skip-cert-verification` `<boolean>` ('default =' `false`)::
+
+Disable TLS certificate verification, only enable on fully trusted networks!

 
 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
 
 
 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
 


@@ -776,7 +808,7 @@ Only list stores which are enabled (not disabled in config).
 
 Include information about formats
 
 
 Include information about formats
 

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

 
 Only list status for  specified storage
 
 
 Only list status for  specified storage