X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pvesm.1-synopsis.adoc;h=930b4a9ea06d616509a36242fc4a5cbd0963a299;hb=7c90d20bb8830f78f97e2f82fe28bf2323b77da7;hp=e7d7f53298488f312c84b21f68d39c98a9b17f3f;hpb=35a75dd36c05f79e9dda81147867878a55d839c1;p=pve-docs.git diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index e7d7f53..930b4a9 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -4,7 +4,7 @@ Create a new storage. -``: `` :: +``: `` :: Storage type. @@ -24,6 +24,10 @@ Base volume. This volume is automatically activated. block size +`--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: + +Set bandwidth/io limits various operations. + `--comstar_hg` `` :: host group for comstar views @@ -38,18 +42,34 @@ Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. +`--datastore` `` :: + +Proxmox backup server datastore name. + `--disable` `` :: Flag to disable the storage. +`--domain` `` :: + +CIFS domain. + `--export` `` :: NFS export path. +`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: + +Certificate SHA 256 fingerprint. + `--format` `` :: Default image format. +`--fuse` `` :: + +Mount CephFS through FUSE. + `--is_mountpoint` `` ('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 +80,11 @@ iscsi provider `--krbd` `` :: -Access rbd through krbd kernel module. +Always access rbd through krbd kernel module. + +`--lio_tpg` `` :: + +target portal group for Linux LIO targets `--maxfiles` ` (0 - N)` :: @@ -74,6 +98,10 @@ Create the directory if it doesn't exist. IP addresses of monitors (for external clusters). +`--mountpoint` `` :: + +mount point + `--nodes` `` :: List of cluster node names. @@ -86,6 +114,10 @@ disable write caching on the target NFS mount options (see 'man nfs') +`--password` `` :: + +Password for CIFS share. + `--path` `` :: File system path. @@ -120,14 +152,26 @@ Backup volfile server IP or DNS name. + NOTE: Requires option(s): `server` +`--share` `` :: + +CIFS share. + `--shared` `` :: Mark storage as shared. +`--smbversion` `<2.0 | 2.1 | 3.0>` :: + +SMB protocol version + `--sparse` `` :: use sparse volumes +`--subdir` `` :: + +Subdir to mount. + `--tagged_only` `` :: Only use logical volumes tagged with 'pve-vm-ID'. @@ -182,6 +226,14 @@ no description available + NOTE: Requires option(s): `size` +*pvesm apiinfo* + +Returns APIVER and APIAGE. + +*pvesm cifsscan* + +An alias for 'pvesm scan cifs'. + *pvesm export* ` ` `[OPTIONS]` Export a volume. @@ -226,17 +278,17 @@ Delete volume Volume identifier -`--storage` `` :: +`--delay` ` (1 - 30)` :: -The storage identifier. +Time to wait for the task to finish. We return 'null' if the task finish within that time. -*pvesm glusterfsscan* `` +`--storage` `` :: -Scan remote GlusterFS server. +The storage identifier. -``: `` :: +*pvesm glusterfsscan* -no description available +An alias for 'pvesm scan glusterfs'. *pvesm help* `[OPTIONS]` @@ -264,7 +316,11 @@ Import stream format ``: `` :: -Source file name +Source file name. For '-' stdin is used, the tcp:// format allows to use a TCP connection as input. Else, the file is treated as common file. + +`--allow-rename` `` ('default =' `0`):: + +Choose a new volume ID if the requested volume ID already exists, instead of throwing an error. `--base` `(?^:[a-z0-9_\-]{1,40})` :: @@ -278,13 +334,9 @@ A snapshot to delete on success Whether the stream includes intermediate snapshots -*pvesm iscsiscan* `--portal ` `[OPTIONS]` +*pvesm iscsiscan* -Scan remote iSCSI server. - -`--portal` `` :: - -no description available +An alias for 'pvesm scan iscsi'. *pvesm list* `` `[OPTIONS]` @@ -304,23 +356,15 @@ Only list images for this VM *pvesm lvmscan* -List local LVM volume groups. - -*pvesm lvmthinscan* `` +An alias for 'pvesm scan lvm'. -List local LVM Thin Pools. - -``: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: +*pvesm lvmthinscan* -no description available - -*pvesm nfsscan* `` - -Scan remote NFS server. +An alias for 'pvesm scan lvmthin'. -``: `` :: +*pvesm nfsscan* -no description available +An alias for 'pvesm scan nfs'. *pvesm path* `` @@ -338,6 +382,66 @@ Delete storage configuration. The storage identifier. +*pvesm scan cifs* `` `[OPTIONS]` + +Scan remote CIFS server. + +``: `` :: + +The server address (name or IP). + +`--domain` `` :: + +SMB domain (Workgroup). + +`--password` `` :: + +User password. + +`--username` `` :: + +User name. + +*pvesm scan glusterfs* `` + +Scan remote GlusterFS server. + +``: `` :: + +The server address (name or IP). + +*pvesm scan iscsi* `` + +Scan remote iSCSI server. + +``: `` :: + +The iSCSI portal (IP or DNS name with optional port). + +*pvesm scan lvm* + +List local LVM volume groups. + +*pvesm scan lvmthin* `` + +List local LVM Thin Pools. + +``: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: + +no description available + +*pvesm scan nfs* `` + +Scan remote NFS server. + +``: `` :: + +The server address (name or IP). + +*pvesm scan zfs* + +Scan zfs pool list on local node. + *pvesm set* `` `[OPTIONS]` Update storage configuration. @@ -350,6 +454,10 @@ The storage identifier. block size +`--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: + +Set bandwidth/io limits various operations. + `--comstar_hg` `` :: host group for comstar views @@ -376,17 +484,33 @@ Prevent changes if current configuration file has different SHA1 digest. This ca Flag to disable the storage. +`--domain` `` :: + +CIFS domain. + +`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: + +Certificate SHA 256 fingerprint. + `--format` `` :: Default image format. +`--fuse` `` :: + +Mount CephFS through FUSE. + `--is_mountpoint` `` ('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` `` :: -Access rbd through krbd kernel module. +Always access rbd through krbd kernel module. + +`--lio_tpg` `` :: + +target portal group for Linux LIO targets `--maxfiles` ` (0 - N)` :: @@ -400,6 +524,10 @@ Create the directory if it doesn't exist. IP addresses of monitors (for external clusters). +`--mountpoint` `` :: + +mount point + `--nodes` `` :: List of cluster node names. @@ -412,6 +540,10 @@ disable write caching on the target NFS mount options (see 'man nfs') +`--password` `` :: + +Password for CIFS share. + `--pool` `` :: Pool. @@ -442,10 +574,18 @@ NOTE: Requires option(s): `server` Mark storage as shared. +`--smbversion` `<2.0 | 2.1 | 3.0>` :: + +SMB protocol version + `--sparse` `` :: use sparse volumes +`--subdir` `` :: + +Subdir to mount. + `--tagged_only` `` :: Only use logical volumes tagged with 'pve-vm-ID'. @@ -484,6 +624,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'.