X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvesm.1-synopsis.adoc;h=d231c485c85aaf02ccafc8e67e49ce8a082276b7;hp=c0cddecf4099f091b76eb0fad509f430cf6343c2;hb=HEAD;hpb=9d2e98ed4f5be0262bb25b1069f8cd1d78fcce3b diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index c0cddec..e5f885f 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -4,11 +4,11 @@ Create a new storage. -``: `` :: +``: `` :: Storage type. -``: `` :: +``: `` :: The storage identifier. @@ -26,7 +26,7 @@ block size `--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: -Set bandwidth/io limits various operations. +Set I/O bandwidth limit for various operations (in KiB/s). `--comstar_hg` `` :: @@ -46,6 +46,14 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. Overrides for default content type directories. +`--create-base-path` `` ('default =' `yes`):: + +Create the base directory if it doesn't exist. + +`--create-subdirs` `` ('default =' `yes`):: + +Populate the directory with the default structure. + `--data-pool` `` :: Data Pool (for erasure coding only) @@ -120,7 +128,7 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. `--mkdir` `` ('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` `` :: @@ -140,7 +148,7 @@ Set the NOCOW flag on files. Disables data checksumming and causes data errors t `--nodes` `` :: -List of cluster node names. +List of nodes for which the storage configuration applies. `--nowritecache` `` :: @@ -148,7 +156,7 @@ disable write caching on the target `--options` `` :: -NFS mount options (see 'man nfs') +NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') `--password` `` :: @@ -162,7 +170,7 @@ File system path. Pool. -`--port` ` (1 - 65535)` ('default =' `8007`):: +`--port` ` (1 - 65535)` :: For non default port. @@ -202,7 +210,11 @@ CIFS share. `--shared` `` :: -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` `` ('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`):: @@ -248,11 +260,11 @@ Glusterfs Volume. Allocate disk images. -``: `` :: +``: `` :: The storage identifier. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: Specify owner VM @@ -330,7 +342,7 @@ Volume identifier Time to wait for the task to finish. We return 'null' if the task finish within that time. -`--storage` `` :: +`--storage` `` :: The storage identifier. @@ -394,7 +406,7 @@ An alias for 'pvesm scan iscsi'. List storage content. -``: `` :: +``: `` :: The storage identifier. @@ -402,7 +414,7 @@ The storage identifier. Only list content of this type. -`--vmid` ` (1 - N)` :: +`--vmid` ` (100 - 999999999)` :: Only list images for this VM @@ -432,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. -``: `` :: +``: `` :: The storage identifier. @@ -472,7 +484,7 @@ Keep backups for the last different years. If there is morethan one backup f Either 'qemu' or 'lxc'. Only consider backups for guests of this type. -`--vmid` ` (1 - N)` :: +`--vmid` ` (100 - 999999999)` :: Only consider backups for this guest. @@ -480,7 +492,7 @@ Only consider backups for this guest. Delete storage configuration. -``: `` :: +``: `` :: The storage identifier. @@ -572,7 +584,7 @@ Scan zfs pool list on local node. Update storage configuration. -``: `` :: +``: `` :: The storage identifier. @@ -582,7 +594,7 @@ block size `--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: -Set bandwidth/io limits various operations. +Set I/O bandwidth limit for various operations (in KiB/s). `--comstar_hg` `` :: @@ -602,6 +614,14 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. Overrides for default content type directories. +`--create-base-path` `` ('default =' `yes`):: + +Create the base directory if it doesn't exist. + +`--create-subdirs` `` ('default =' `yes`):: + +Populate the directory with the default structure. + `--data-pool` `` :: Data Pool (for erasure coding only) @@ -612,7 +632,7 @@ A list of settings you want to delete. `--digest` `` :: -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` `` :: @@ -672,7 +692,7 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. `--mkdir` `` ('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` `` :: @@ -692,7 +712,7 @@ Set the NOCOW flag on files. Disables data checksumming and causes data errors t `--nodes` `` :: -List of cluster node names. +List of nodes for which the storage configuration applies. `--nowritecache` `` :: @@ -700,7 +720,7 @@ disable write caching on the target `--options` `` :: -NFS mount options (see 'man nfs') +NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') `--password` `` :: @@ -710,7 +730,7 @@ Password for accessing the share/datastore. Pool. -`--port` ` (1 - 65535)` ('default =' `8007`):: +`--port` ` (1 - 65535)` :: For non default port. @@ -742,7 +762,11 @@ NOTE: Requires option(s): `server` `--shared` `` :: -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` `` ('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`):: @@ -784,7 +808,7 @@ Only list stores which are enabled (not disabled in config). Include information about formats -`--storage` `` :: +`--storage` `` :: Only list status for specified storage