X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvesm.1-synopsis.adoc;h=5a71906311410773811026056d8fab464ad89d78;hp=326c6038218ee93ee7475f86c771574d377b34dc;hb=856993e4166495537f42e0b9c3a51c966227feab;hpb=2489d6df4ac5e916ae18401310bfd1e69c993e55 diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index 326c603..5a71906 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. @@ -60,7 +72,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)` :: @@ -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,9 @@ no description available + NOTE: Requires option(s): `size` +*pvesm cifsscan* - +An alias for 'pvesm scan cifs'. *pvesm export* ` ` `[OPTIONS]` @@ -216,8 +246,6 @@ Snapshot to export Whether to include intermediate snapshots in the stream - - *pvesm extractconfig* `` Extract configuration from vzdump backup archive. @@ -226,9 +254,6 @@ Extract configuration from vzdump backup archive. Volume identifier - - - *pvesm free* `` `[OPTIONS]` Delete volume @@ -241,35 +266,22 @@ Volume identifier The storage identifier. +*pvesm glusterfsscan* +An alias for 'pvesm scan glusterfs'. - -*pvesm glusterfsscan* `` - -Scan remote GlusterFS server. - -``: `` :: - -no description available - - - - -*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 +310,9 @@ A snapshot to delete on success Whether the stream includes intermediate snapshots +*pvesm iscsiscan* - - -*pvesm iscsiscan* `--portal ` `[OPTIONS]` - -Scan remote iSCSI server. - -`--portal` `` :: - -no description available - - - +An alias for 'pvesm scan iscsi'. *pvesm list* `` `[OPTIONS]` @@ -328,56 +330,93 @@ Only list content of this type. Only list images for this VM +*pvesm lvmscan* +An alias for 'pvesm scan lvm'. +*pvesm lvmthinscan* -*pvesm lvmscan* +An alias for 'pvesm scan lvmthin'. -List local LVM volume groups. +*pvesm nfsscan* +An alias for 'pvesm scan nfs'. +*pvesm path* `` -*pvesm lvmthinscan* `` +Get filesystem path for specified volume -List local LVM Thin Pools. +``: `` :: -``: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: +Volume identifier -no description available +*pvesm remove* `` +Delete storage configuration. +``: `` :: -*pvesm nfsscan* `` +The storage identifier. -Scan remote NFS server. +*pvesm scan cifs* `` `[OPTIONS]` + +Scan remote CIFS server. ``: `` :: -no description available +The server address (name or IP). +`--domain` `` :: +SMB domain (Workgroup). +`--password` `` :: -*pvesm path* `` +User password. -Get filesystem path for specified volume +`--username` `` :: -``: `` :: +User name. -Volume identifier +*pvesm scan glusterfs* `` +Scan remote GlusterFS server. +``: `` :: +The server address (name or IP). -*pvesm remove* `` +*pvesm scan iscsi* `` -Delete storage configuration. +Scan remote iSCSI server. -``: `` :: +``: `` :: -The storage identifier. +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]` @@ -391,6 +430,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,17 +460,29 @@ 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. `--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)` :: @@ -453,6 +508,10 @@ disable write caching on the target NFS mount options (see 'man nfs') +`--password` `` :: + +Password for CIFS share. + `--pool` `` :: Pool. @@ -483,10 +542,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 +566,6 @@ Gluster transport: tcp or rdma RBD Id. - - - *pvesm status* `[OPTIONS]` Get status for all datastores. @@ -514,6 +578,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 +590,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. - - +An alias for 'pvesm scan zfs'.