X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvesm.1-synopsis.adoc;h=666c39b44cd9e88dcc9916de849bbe773ebfa13e;hp=56f697ada3294d05a327c0e388f87dc0895438cc;hb=12eb9705ac209cefb35c66d53e4e172ee7c8047e;hpb=013dc89ffce47b8c55412c016a508205768b4fd6 diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index 56f697a..666c39b 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -4,7 +4,7 @@ Create a new storage. -``: `` :: +``: `` :: Storage type. @@ -12,153 +12,170 @@ Storage type. The storage identifier. -`-authsupported` `` :: +`--authsupported` `` :: Authsupported. -`-base` `` :: +`--base` `` :: Base volume. This volume is automatically activated. -`-blocksize` `` :: +`--blocksize` `` :: block size -`-comstar_hg` `` :: +`--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: + +Set bandwidth/io limits various operations. + +`--comstar_hg` `` :: host group for comstar views -`-comstar_tg` `` :: +`--comstar_tg` `` :: target group for comstar views -`-content` `` :: +`--content` `` :: Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. -`-disable` `` :: +`--disable` `` :: Flag to disable the storage. -`-export` `` :: +`--domain` `` :: + +CIFS domain. + +`--export` `` :: NFS export path. -`-format` `` :: +`--format` `` :: Default image format. -`-is_mountpoint` `` ('default =' `no`):: +`--is_mountpoint` `` ('default =' `no`):: -Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. +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. -`-iscsiprovider` `` :: +`--iscsiprovider` `` :: iscsi provider -`-krbd` `` :: +`--krbd` `` :: Access rbd through krbd kernel module. -`-maxfiles` ` (0 - N)` :: +`--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. -`-mkdir` `` ('default =' `yes`):: +`--mkdir` `` ('default =' `yes`):: Create the directory if it doesn't exist. -`-monhost` `` :: +`--monhost` `` :: -Monitors daemon ips. +IP addresses of monitors (for external clusters). -`-nodes` `` :: +`--nodes` `` :: List of cluster node names. -`-nowritecache` `` :: +`--nowritecache` `` :: disable write caching on the target -`-options` `` :: +`--options` `` :: NFS mount options (see 'man nfs') -`-path` `` :: +`--password` :: + +Password for CIFS share. + +`--path` `` :: File system path. -`-pool` `` :: +`--pool` `` :: Pool. -`-portal` `` :: +`--portal` `` :: iSCSI portal (IP or DNS name with optional port). -`-redundancy` ` (1 - 16)` ('default =' `2`):: +`--redundancy` ` (1 - 16)` ('default =' `2`):: The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster. -`-saferemove` `` :: +`--saferemove` `` :: Zero-out data when removing LVs. -`-saferemove_throughput` `` :: +`--saferemove_throughput` `` :: Wipe throughput (cstream -t parameter value). -`-server` `` :: +`--server` `` :: Server IP or DNS name. -`-server2` `` :: +`--server2` `` :: Backup volfile server IP or DNS name. + NOTE: Requires option(s): `server` -`-shared` `` :: +`--share` `` :: + +CIFS share. + +`--shared` `` :: Mark storage as shared. -`-sparse` `` :: +`--smbversion` `` :: + +no description available + +`--sparse` `` :: use sparse volumes -`-tagged_only` `` :: +`--tagged_only` `` :: Only use logical volumes tagged with 'pve-vm-ID'. -`-target` `` :: +`--target` `` :: iSCSI target. -`-thinpool` `` :: +`--thinpool` `` :: LVM thin pool LV name. -`-transport` `` :: +`--transport` `` :: Gluster transport: tcp or rdma -`-username` `` :: +`--username` `` :: RBD Id. -`-vgname` `` :: +`--vgname` `` :: Volume group name. -`-volume` `` :: +`--volume` `` :: Glusterfs Volume. - - - *pvesm alloc* ` ` `[OPTIONS]` Allocate disk images. @@ -179,40 +196,79 @@ The name of the file to create. Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) -`-format` `` :: +`--format` `` :: no description available + NOTE: Requires option(s): `size` +*pvesm cifsscan* `` `[OPTIONS]` +Scan remote CIFS server. +``: `` :: -*pvesm extractconfig* `` +no description available -Extract configuration from vzdump backup archive. +`--domain` `` :: + +no description available + +`--password` :: + +no description available + +`--username` `` :: + +no description available + +*pvesm export* ` ` `[OPTIONS]` + +Export a volume. ``: `` :: Volume identifier +``: `` :: +Export stream format +``: `` :: -*pvesm free* `` `[OPTIONS]` +Destination file name -Delete volume +`--base` `(?^:[a-z0-9_\-]{1,40})` :: + +Snapshot to start an incremental stream from + +`--snapshot` `(?^:[a-z0-9_\-]{1,40})` :: + +Snapshot to export + +`--with-snapshots` `` ('default =' `0`):: + +Whether to include intermediate snapshots in the stream + +*pvesm extractconfig* `` + +Extract configuration from vzdump backup archive. ``: `` :: Volume identifier -`-storage` `` :: +*pvesm free* `` `[OPTIONS]` + +Delete volume -The storage identifier. +``: `` :: +Volume identifier +`--storage` `` :: +The storage identifier. *pvesm glusterfsscan* `` @@ -222,34 +278,53 @@ Scan remote GlusterFS server. no description available +*pvesm help* `[OPTIONS]` +Get help about specified command. +`--extra-args` `` :: -*pvesm help* `[]` `[OPTIONS]` +Shows help for a specific command -Get help about specified command. +`--verbose` `` :: -``: `` :: +Verbose output format. -Command name +*pvesm import* ` ` `[OPTIONS]` -`-verbose` `` :: +Import a volume. -Verbose output format. +``: `` :: +Volume identifier +``: `` :: +Import stream format -*pvesm iscsiscan* `-portal ` `[OPTIONS]` +``: `` :: -Scan remote iSCSI server. +Source file name -`-portal` `` :: +`--base` `(?^:[a-z0-9_\-]{1,40})` :: -no description available +Base snapshot of an incremental stream + +`--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` :: +A snapshot to delete on success +`--with-snapshots` `` ('default =' `0`):: +Whether the stream includes intermediate snapshots + +*pvesm iscsiscan* `--portal ` `[OPTIONS]` + +Scan remote iSCSI server. + +`--portal` `` :: + +no description available *pvesm list* `` `[OPTIONS]` @@ -259,23 +334,18 @@ List storage content. The storage identifier. -`-content` `` :: +`--content` `` :: Only list content of this type. -`-vmid` ` (1 - N)` :: +`--vmid` ` (1 - N)` :: Only list images for this VM - - - *pvesm lvmscan* List local LVM volume groups. - - *pvesm lvmthinscan* `` List local LVM Thin Pools. @@ -284,8 +354,6 @@ List local LVM Thin Pools. no description available - - *pvesm nfsscan* `` Scan remote NFS server. @@ -294,9 +362,6 @@ Scan remote NFS server. no description available - - - *pvesm path* `` Get filesystem path for specified volume @@ -305,9 +370,6 @@ Get filesystem path for specified volume Volume identifier - - - *pvesm remove* `` Delete storage configuration. @@ -316,8 +378,6 @@ Delete storage configuration. The storage identifier. - - *pvesm set* `` `[OPTIONS]` Update storage configuration. @@ -326,144 +386,160 @@ Update storage configuration. The storage identifier. -`-blocksize` `` :: +`--blocksize` `` :: block size -`-comstar_hg` `` :: +`--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: + +Set bandwidth/io limits various operations. + +`--comstar_hg` `` :: host group for comstar views -`-comstar_tg` `` :: +`--comstar_tg` `` :: target group for comstar views -`-content` `` :: +`--content` `` :: Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-disable` `` :: +`--disable` `` :: Flag to disable the storage. -`-format` `` :: +`--domain` `` :: + +CIFS domain. + +`--format` `` :: Default image format. -`-is_mountpoint` `` ('default =' `no`):: +`--is_mountpoint` `` ('default =' `no`):: -Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. +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` `` :: +`--krbd` `` :: Access rbd through krbd kernel module. -`-maxfiles` ` (0 - N)` :: +`--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. -`-mkdir` `` ('default =' `yes`):: +`--mkdir` `` ('default =' `yes`):: Create the directory if it doesn't exist. -`-nodes` `` :: +`--monhost` `` :: + +IP addresses of monitors (for external clusters). + +`--nodes` `` :: List of cluster node names. -`-nowritecache` `` :: +`--nowritecache` `` :: disable write caching on the target -`-options` `` :: +`--options` `` :: NFS mount options (see 'man nfs') -`-pool` `` :: +`--password` :: + +Password for CIFS share. + +`--pool` `` :: Pool. -`-redundancy` ` (1 - 16)` ('default =' `2`):: +`--redundancy` ` (1 - 16)` ('default =' `2`):: The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster. -`-saferemove` `` :: +`--saferemove` `` :: Zero-out data when removing LVs. -`-saferemove_throughput` `` :: +`--saferemove_throughput` `` :: Wipe throughput (cstream -t parameter value). -`-server` `` :: +`--server` `` :: Server IP or DNS name. -`-server2` `` :: +`--server2` `` :: Backup volfile server IP or DNS name. + NOTE: Requires option(s): `server` -`-shared` `` :: +`--shared` `` :: Mark storage as shared. -`-sparse` `` :: +`--smbversion` `` :: + +no description available + +`--sparse` `` :: use sparse volumes -`-tagged_only` `` :: +`--tagged_only` `` :: Only use logical volumes tagged with 'pve-vm-ID'. -`-transport` `` :: +`--transport` `` :: Gluster transport: tcp or rdma -`-username` `` :: +`--username` `` :: RBD Id. - - - *pvesm status* `[OPTIONS]` Get status for all datastores. -`-content` `` :: +`--content` `` :: Only list stores which support this content type. -`-enabled` `` ('default =' `0`):: +`--enabled` `` ('default =' `0`):: Only list stores which are enabled (not disabled in config). -`-storage` `` :: - -Only list status for specified storage +`--format` `` ('default =' `0`):: -`-target` `` :: +Include information about formats -If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. +`--storage` `` :: +Only list status for specified storage +`--target` `` :: +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. - -