readme: extend macro section

[pve-docs.git] / pvesm.1-synopsis.adoc

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index 0899a5d2118a71ac3ae6542d4b88acb058cc0f8a..9c7b5c6ef67d263d1cf02afe8900b58a8417be1f 100644 (file)
--- a/pvesm.1-synopsis.adoc
+++ b/pvesm.1-synopsis.adoc
@@ -34,8 +34,9 @@ target group for comstar views
 
 `-content` `string` ::
 
-Allowed content types. Note: value 'rootdir' is used for Containers, and
-value 'images' for KVM-Qemu VM's.
+Allowed content types.
++
+NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
 `-disable` `boolean` ::
 
@@ -47,7 +48,11 @@ NFS export path.
 
 `-format` `string` ::
 
-Default Image format.
+Default image format.
+
+`-is_mountpoint` `boolean` (default=`no`)::
+
+Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
 
 `-iscsiprovider` `string` ::
 
@@ -61,6 +66,10 @@ Access rbd through krbd kernel module.
 
 Maximal number of backup files per VM. Use '0' for unlimted.
 
+`-mkdir` `boolean` (default=`yes`)::
+
+Create the directory if it doesn't exist.
+
 `-monhost` `string` ::
 
 Monitors daemon ips.
@@ -91,9 +100,7 @@ iSCSI portal (IP or DNS name with optional port).
 
 `-redundancy` `integer (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.
+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` ::
 
@@ -107,7 +114,7 @@ Wipe throughput (cstream -t parameter value).
 
 Server IP or DNS name.
 
-`-server[n]` `string` ::
+`-server2` `string` ::
 
 Backup volfile server IP or DNS name.
 +
@@ -121,6 +128,10 @@ Mark storage as shared.
 
 use sparse volumes
 
+`-tagged_only` `boolean` ::
+
+Only use logical volumes tagged with 'pve-vm-ID'.
+
 `-target` `string` ::
 
 iSCSI target.
@@ -166,8 +177,7 @@ The name of the file to create.
 
 `<size>` `\d+[MG]?` ::
 
-Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and
-'G' (gigabyte, 1024M)
+Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
 
 `-format` `(qcow2 | raw | subvol)` ::
 
@@ -177,6 +187,18 @@ NOTE: Requires option(s): `size`
 
 
 
+
+*pvesm extractconfig* `<volume>`
+
+Extract configuration from vzdump backup archive.
+
+`<volume>` `string` ::
+
+Volume identifier
+
+
+
+
 *pvesm free* `<volume>` `[OPTIONS]`
 
 Delete volume
@@ -318,8 +340,9 @@ target group for comstar views
 
 `-content` `string` ::
 
-Allowed content types. Note: value 'rootdir' is used for Containers, and
-value 'images' for KVM-Qemu VM's.
+Allowed content types.
++
+NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
 `-delete` `string` ::
 
@@ -327,8 +350,7 @@ A list of settings you want to delete.
 
 `-digest` `string` ::
 
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 
 `-disable` `boolean` ::
 
@@ -336,7 +358,11 @@ Flag to disable the storage.
 
 `-format` `string` ::
 
-Default Image format.
+Default image format.
+
+`-is_mountpoint` `boolean` (default=`no`)::
+
+Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
 
 `-krbd` `boolean` ::
 
@@ -346,6 +372,10 @@ Access rbd through krbd kernel module.
 
 Maximal number of backup files per VM. Use '0' for unlimted.
 
+`-mkdir` `boolean` (default=`yes`)::
+
+Create the directory if it doesn't exist.
+
 `-nodes` `string` ::
 
 List of cluster node names.
@@ -364,9 +394,7 @@ Pool.
 
 `-redundancy` `integer (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.
+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` ::
 
@@ -380,7 +408,7 @@ Wipe throughput (cstream -t parameter value).
 
 Server IP or DNS name.
 
-`-server[n]` `string` ::
+`-server2` `string` ::
 
 Backup volfile server IP or DNS name.
 +
@@ -394,6 +422,10 @@ Mark storage as shared.
 
 use sparse volumes
 
+`-tagged_only` `boolean` ::
+
+Only use logical volumes tagged with 'pve-vm-ID'.
+
 `-transport` `(rdma | tcp | unix)` ::
 
 Gluster transport: tcp or rdma
@@ -423,8 +455,7 @@ Only list status for  specified storage
 
 `-target` `string` ::
 
-If target is different to 'node', we only lists shared storages which
-content is accessible on this 'node' and the specified 'target' node.
+If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.