X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pvesm.1-synopsis.adoc;h=930b4a9ea06d616509a36242fc4a5cbd0963a299;hb=42449bdff931a4daf9c0b134e31071928be1ea77;hp=9c5e61499579235cb0945ad94917564981c6d7fa;hpb=4d47f12597815e9a1fc3f3c1b4020e0d5c106254;p=pve-docs.git diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index 9c5e614..930b4a9 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -4,7 +4,7 @@ Create a new storage. -``: `` :: +``: `` :: Storage type. @@ -42,6 +42,10 @@ 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. @@ -54,6 +58,10 @@ CIFS domain. NFS export path. +`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: + +Certificate SHA 256 fingerprint. + `--format` `` :: Default image format. @@ -72,7 +80,7 @@ iscsi provider `--krbd` `` :: -Access rbd through krbd kernel module. +Always access rbd through krbd kernel module. `--lio_tpg` `` :: @@ -90,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. @@ -214,25 +226,13 @@ no description available + NOTE: Requires option(s): `size` -*pvesm cifsscan* `` `[OPTIONS]` - -Scan remote CIFS server. - -``: `` :: - -The server address (name or IP). - -`--domain` `` :: +*pvesm apiinfo* -SMB domain (Workgroup). +Returns APIVER and APIAGE. -`--password` `` :: +*pvesm cifsscan* -User password. - -`--username` `` :: - -User name. +An alias for 'pvesm scan cifs'. *pvesm export* ` ` `[OPTIONS]` @@ -278,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* -The server address (name or IP). +An alias for 'pvesm scan glusterfs'. *pvesm help* `[OPTIONS]` @@ -316,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})` :: @@ -330,13 +334,9 @@ A snapshot to delete on success Whether the stream includes intermediate snapshots -*pvesm iscsiscan* `` +*pvesm iscsiscan* -Scan remote iSCSI server. - -``: `` :: - -The iSCSI portal (IP or DNS name with optional port). +An alias for 'pvesm scan iscsi'. *pvesm list* `` `[OPTIONS]` @@ -356,23 +356,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\.\+\_\-]+` :: +An alias for 'pvesm scan lvm'. -no description available +*pvesm lvmthinscan* -*pvesm nfsscan* `` +An alias for 'pvesm scan lvmthin'. -Scan remote NFS server. +*pvesm nfsscan* -``: `` :: - -The server address (name or IP). +An alias for 'pvesm scan nfs'. *pvesm path* `` @@ -390,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. @@ -436,6 +488,10 @@ Flag to disable the storage. CIFS domain. +`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: + +Certificate SHA 256 fingerprint. + `--format` `` :: Default image format. @@ -450,7 +506,7 @@ Assume the given path is an externally managed mountpoint and consider the stora `--krbd` `` :: -Access rbd through krbd kernel module. +Always access rbd through krbd kernel module. `--lio_tpg` `` :: @@ -468,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. @@ -564,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'.