X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pvesm.1-synopsis.adoc;h=df90d7c26640878e390b0b107d73164c92574e9e;hb=3cae5b16cba0d0eef547cb082c18c40ac9ae33a6;hp=f78a0aa10d57c21641d529018dbf2c494b16d22a;hpb=c2993fe56c757a6b53001af4b2af6517ef598f1e;p=pve-docs.git diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index f78a0aa..df90d7c 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -4,143 +4,155 @@ Create a new storage. -`` `(dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool)` :: +``: `` :: Storage type. -`` `string` :: +``: `` :: The storage identifier. -`-authsupported` `string` :: +`-authsupported` `` :: Authsupported. -`-base` `string` :: +`-base` `` :: Base volume. This volume is automatically activated. -`-blocksize` `string` :: +`-blocksize` `` :: block size -`-comstar_hg` `string` :: +`-comstar_hg` `` :: host group for comstar views -`-comstar_tg` `string` :: +`-comstar_tg` `` :: target group for comstar views -`-content` `string` :: +`-content` `` :: Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. -`-disable` `boolean` :: +`-disable` `` :: Flag to disable the storage. -`-export` `string` :: +`-export` `` :: NFS export path. -`-format` `string` :: +`-format` `` :: Default image format. -`-iscsiprovider` `string` :: +`-is_mountpoint` `` ('default =' `no`):: + +Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. + +`-iscsiprovider` `` :: iscsi provider -`-krbd` `boolean` :: +`-krbd` `` :: Access rbd through krbd kernel module. -`-maxfiles` `integer (0 - N)` :: +`-maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. -`-monhost` `string` :: +`-mkdir` `` ('default =' `yes`):: + +Create the directory if it doesn't exist. + +`-monhost` `` :: Monitors daemon ips. -`-nodes` `string` :: +`-nodes` `` :: List of cluster node names. -`-nowritecache` `boolean` :: +`-nowritecache` `` :: disable write caching on the target -`-options` `string` :: +`-options` `` :: NFS mount options (see 'man nfs') -`-path` `string` :: +`-path` `` :: File system path. -`-pool` `string` :: +`-pool` `` :: Pool. -`-portal` `string` :: +`-portal` `` :: iSCSI portal (IP or DNS name with optional port). -`-redundancy` `integer (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` `boolean` :: +`-saferemove` `` :: Zero-out data when removing LVs. -`-saferemove_throughput` `string` :: +`-saferemove_throughput` `` :: Wipe throughput (cstream -t parameter value). -`-server` `string` :: +`-server` `` :: Server IP or DNS name. -`-server2` `string` :: +`-server2` `` :: Backup volfile server IP or DNS name. + NOTE: Requires option(s): `server` -`-shared` `boolean` :: +`-shared` `` :: Mark storage as shared. -`-sparse` `boolean` :: +`-sparse` `` :: use sparse volumes -`-target` `string` :: +`-tagged_only` `` :: + +Only use logical volumes tagged with 'pve-vm-ID'. + +`-target` `` :: iSCSI target. -`-thinpool` `string` :: +`-thinpool` `` :: LVM thin pool LV name. -`-transport` `(rdma | tcp | unix)` :: +`-transport` `` :: Gluster transport: tcp or rdma -`-username` `string` :: +`-username` `` :: RBD Id. -`-vgname` `string` :: +`-vgname` `` :: Volume group name. -`-volume` `string` :: +`-volume` `` :: Glusterfs Volume. @@ -151,23 +163,23 @@ Glusterfs Volume. Allocate disk images. -`` `string` :: +``: `` :: The storage identifier. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: Specify owner VM -`` `string` :: +``: `` :: The name of the file to create. -`` `\d+[MG]?` :: +``: `\d+[MG]?` :: Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) -`-format` `(qcow2 | raw | subvol)` :: +`-format` `` :: no description available + @@ -175,15 +187,57 @@ NOTE: Requires option(s): `size` + +*pvesm export* ` ` `[OPTIONS]` + +Export a volume. + +``: `` :: + +Volume identifier + +``: `` :: + +Export stream format + +``: `` :: + +Destination file name + +`-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 + + + + *pvesm free* `` `[OPTIONS]` Delete volume -`` `string` :: +``: `` :: Volume identifier -`-storage` `string` :: +`-storage` `` :: The storage identifier. @@ -194,7 +248,7 @@ The storage identifier. Scan remote GlusterFS server. -`` `string` :: +``: `` :: no description available @@ -205,22 +259,53 @@ no description available Get help about specified command. -`` `string` :: +``: `` :: Command name -`-verbose` `boolean` :: +`-verbose` `` :: Verbose output format. +*pvesm import* ` ` `[OPTIONS]` + +Import a volume. + +``: `` :: + +Volume identifier + +``: `` :: + +Import stream format + +``: `` :: + +Source file name + +`-base` `(?^:[a-z0-9_\-]{1,40})` :: + +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` `string` :: +`-portal` `` :: no description available @@ -231,15 +316,15 @@ no description available List storage content. -`` `string` :: +``: `` :: The storage identifier. -`-content` `string` :: +`-content` `` :: Only list content of this type. -`-vmid` `integer (1 - N)` :: +`-vmid` ` (1 - N)` :: Only list images for this VM @@ -256,7 +341,7 @@ List local LVM volume groups. List local LVM Thin Pools. -`` `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: +``: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: no description available @@ -266,7 +351,7 @@ no description available Scan remote NFS server. -`` `string` :: +``: `` :: no description available @@ -277,7 +362,7 @@ no description available Get filesystem path for specified volume -`` `string` :: +``: `` :: Volume identifier @@ -288,7 +373,7 @@ Volume identifier Delete storage configuration. -`` `string` :: +``: `` :: The storage identifier. @@ -298,103 +383,115 @@ The storage identifier. Update storage configuration. -`` `string` :: +``: `` :: The storage identifier. -`-blocksize` `string` :: +`-blocksize` `` :: block size -`-comstar_hg` `string` :: +`-comstar_hg` `` :: host group for comstar views -`-comstar_tg` `string` :: +`-comstar_tg` `` :: target group for comstar views -`-content` `string` :: +`-content` `` :: Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. -`-delete` `string` :: +`-delete` `` :: A list of settings you want to delete. -`-digest` `string` :: +`-digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-disable` `boolean` :: +`-disable` `` :: Flag to disable the storage. -`-format` `string` :: +`-format` `` :: Default image format. -`-krbd` `boolean` :: +`-is_mountpoint` `` ('default =' `no`):: + +Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. + +`-krbd` `` :: Access rbd through krbd kernel module. -`-maxfiles` `integer (0 - N)` :: +`-maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. -`-nodes` `string` :: +`-mkdir` `` ('default =' `yes`):: + +Create the directory if it doesn't exist. + +`-nodes` `` :: List of cluster node names. -`-nowritecache` `boolean` :: +`-nowritecache` `` :: disable write caching on the target -`-options` `string` :: +`-options` `` :: NFS mount options (see 'man nfs') -`-pool` `string` :: +`-pool` `` :: Pool. -`-redundancy` `integer (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` `boolean` :: +`-saferemove` `` :: Zero-out data when removing LVs. -`-saferemove_throughput` `string` :: +`-saferemove_throughput` `` :: Wipe throughput (cstream -t parameter value). -`-server` `string` :: +`-server` `` :: Server IP or DNS name. -`-server2` `string` :: +`-server2` `` :: Backup volfile server IP or DNS name. + NOTE: Requires option(s): `server` -`-shared` `boolean` :: +`-shared` `` :: Mark storage as shared. -`-sparse` `boolean` :: +`-sparse` `` :: use sparse volumes -`-transport` `(rdma | tcp | unix)` :: +`-tagged_only` `` :: + +Only use logical volumes tagged with 'pve-vm-ID'. + +`-transport` `` :: Gluster transport: tcp or rdma -`-username` `string` :: +`-username` `` :: RBD Id. @@ -405,19 +502,19 @@ RBD Id. Get status for all datastores. -`-content` `string` :: +`-content` `` :: Only list stores which support this content type. -`-enabled` `boolean` (default=`0`):: +`-enabled` `` ('default =' `0`):: Only list stores which are enabled (not disabled in config). -`-storage` `string` :: +`-storage` `` :: Only list status for specified storage -`-target` `string` :: +`-target` `` :: If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.