X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvesm.1-synopsis.adoc;h=9c5e61499579235cb0945ad94917564981c6d7fa;hp=326c6038218ee93ee7475f86c771574d377b34dc;hb=2da12b297b7b1ca8087aa07959104d85de5c85be;hpb=2489d6df4ac5e916ae18401310bfd1e69c993e55 diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index 326c603..9c5e614 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 @@ -42,6 +46,10 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. Flag to disable the storage. +`--domain` `` :: + +CIFS domain. + `--export` `` :: NFS export path. @@ -50,6 +58,10 @@ NFS export path. 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. @@ -62,6 +74,10 @@ iscsi provider Access rbd through krbd kernel module. +`--lio_tpg` `` :: + +target portal group for Linux LIO targets + `--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. @@ -86,6 +102,10 @@ disable write caching on the target NFS mount options (see 'man nfs') +`--password` `` :: + +Password for CIFS share. + `--path` `` :: File system path. @@ -120,14 +140,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'. @@ -156,9 +188,6 @@ Volume group name. Glusterfs Volume. - - - *pvesm alloc* ` ` `[OPTIONS]` Allocate disk images. @@ -185,8 +214,25 @@ no description available + NOTE: Requires option(s): `size` +*pvesm cifsscan* `` `[OPTIONS]` + +Scan remote CIFS server. + +``: `` :: + +The server address (name or IP). +`--domain` `` :: +SMB domain (Workgroup). + +`--password` `` :: + +User password. + +`--username` `` :: + +User name. *pvesm export* ` ` `[OPTIONS]` @@ -216,8 +262,6 @@ Snapshot to export Whether to include intermediate snapshots in the stream - - *pvesm extractconfig* `` Extract configuration from vzdump backup archive. @@ -226,9 +270,6 @@ Extract configuration from vzdump backup archive. Volume identifier - - - *pvesm free* `` `[OPTIONS]` Delete volume @@ -241,35 +282,26 @@ Volume identifier The storage identifier. - - - *pvesm glusterfsscan* `` Scan remote GlusterFS server. ``: `` :: -no description available - +The server address (name or IP). - - -*pvesm help* `[]` `[OPTIONS]` +*pvesm help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pvesm import* ` ` `[OPTIONS]` Import a volume. @@ -298,19 +330,13 @@ 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 - - +``: `` :: +The iSCSI portal (IP or DNS name with optional port). *pvesm list* `` `[OPTIONS]` @@ -328,15 +354,10 @@ Only list content of this type. Only list images for this VM - - - *pvesm lvmscan* List local LVM volume groups. - - *pvesm lvmthinscan* `` List local LVM Thin Pools. @@ -345,18 +366,13 @@ List local LVM Thin Pools. no description available - - *pvesm nfsscan* `` Scan remote NFS server. ``: `` :: -no description available - - - +The server address (name or IP). *pvesm path* `` @@ -366,9 +382,6 @@ Get filesystem path for specified volume Volume identifier - - - *pvesm remove* `` Delete storage configuration. @@ -377,8 +390,6 @@ Delete storage configuration. The storage identifier. - - *pvesm set* `` `[OPTIONS]` Update storage configuration. @@ -391,6 +402,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 @@ -417,10 +432,18 @@ Prevent changes if current configuration file has different SHA1 digest. This ca Flag to disable the storage. +`--domain` `` :: + +CIFS domain. + `--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. @@ -429,6 +452,10 @@ Assume the given path is an externally managed mountpoint and consider the stora Access rbd through krbd kernel module. +`--lio_tpg` `` :: + +target portal group for Linux LIO targets + `--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. @@ -453,6 +480,10 @@ disable write caching on the target NFS mount options (see 'man nfs') +`--password` `` :: + +Password for CIFS share. + `--pool` `` :: Pool. @@ -483,10 +514,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'. @@ -499,9 +538,6 @@ Gluster transport: tcp or rdma RBD Id. - - - *pvesm status* `[OPTIONS]` Get status for all datastores. @@ -514,6 +550,10 @@ Only list stores which support this content type. Only list stores which are enabled (not disabled in config). +`--format` `` ('default =' `0`):: + +Include information about formats + `--storage` `` :: Only list status for specified storage @@ -522,13 +562,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. - - - *pvesm zfsscan* Scan zfs pool list on local node. - -