X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvesm.1-synopsis.adoc;h=5a71906311410773811026056d8fab464ad89d78;hp=e7d7f53298488f312c84b21f68d39c98a9b17f3f;hb=42a167208676dd7b0fd0793a5f3809061a0e8f38;hpb=35a75dd36c05f79e9dda81147867878a55d839c1 diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index e7d7f53..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'. @@ -182,6 +214,10 @@ no description available + NOTE: Requires option(s): `size` +*pvesm cifsscan* + +An alias for 'pvesm scan cifs'. + *pvesm export* ` ` `[OPTIONS]` Export a volume. @@ -230,13 +266,9 @@ Volume identifier The storage identifier. -*pvesm glusterfsscan* `` +*pvesm glusterfsscan* -Scan remote GlusterFS server. - -``: `` :: - -no description available +An alias for 'pvesm scan glusterfs'. *pvesm help* `[OPTIONS]` @@ -278,13 +310,9 @@ A snapshot to delete on success Whether the stream includes intermediate snapshots -*pvesm iscsiscan* `--portal ` `[OPTIONS]` - -Scan remote iSCSI server. - -`--portal` `` :: +*pvesm iscsiscan* -no description available +An alias for 'pvesm scan iscsi'. *pvesm list* `` `[OPTIONS]` @@ -304,23 +332,15 @@ Only list images for this VM *pvesm lvmscan* -List local LVM volume groups. - -*pvesm lvmthinscan* `` - -List local LVM Thin Pools. - -``: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: - -no description available +An alias for 'pvesm scan lvm'. -*pvesm nfsscan* `` +*pvesm lvmthinscan* -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 +358,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 +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 @@ -376,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)` :: @@ -412,6 +508,10 @@ disable write caching on the target NFS mount options (see 'man nfs') +`--password` `` :: + +Password for CIFS share. + `--pool` `` :: Pool. @@ -442,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'. @@ -484,6 +592,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'.