more ACME documentation

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

*pvesm* `<COMMAND> [ARGS] [OPTIONS]`

*pvesm add* `<type> <storage>` `[OPTIONS]`

Create a new storage.

`<type>`: `<cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::

Storage type.

`<storage>`: `<string>` ::

The storage identifier.

`--authsupported` `<string>` ::

Authsupported.

`--base` `<string>` ::

Base volume. This volume is automatically activated.

`--blocksize` `<string>` ::

block size

`--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::

Set bandwidth/io limits various operations.

`--comstar_hg` `<string>` ::

host group for comstar views

`--comstar_tg` `<string>` ::

target group for comstar views

`--content` `<string>` ::

Allowed content types.
+
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.

`--disable` `<boolean>` ::

Flag to disable the storage.

`--domain` `<string>` ::

CIFS domain.

`--export` `<string>` ::

NFS export path.

`--format` `<string>` ::

Default image format.

`--is_mountpoint` `<string>` ('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.

`--iscsiprovider` `<string>` ::

iscsi provider

`--krbd` `<boolean>` ::

Access rbd through krbd kernel module.

`--maxfiles` `<integer> (0 - N)` ::

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>` ::

IP addresses of monitors (for external clusters).

`--nodes` `<string>` ::

List of cluster node names.

`--nowritecache` `<boolean>` ::

disable write caching on the target

`--options` `<string>` ::

NFS mount options (see 'man nfs')

`--password` ::

Password for CIFS share.

`--path` `<string>` ::

File system path.

`--pool` `<string>` ::

Pool.

`--portal` `<string>` ::

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.

`--saferemove` `<boolean>` ::

Zero-out data when removing LVs.

`--saferemove_throughput` `<string>` ::

Wipe throughput (cstream -t parameter value).

`--server` `<string>` ::

Server IP or DNS name.

`--server2` `<string>` ::

Backup volfile server IP or DNS name.
+
NOTE: Requires option(s): `server`

`--share` `<string>` ::

CIFS share.

`--shared` `<boolean>` ::

Mark storage as shared.

`--smbversion` `<string>` ::

no description available

`--sparse` `<boolean>` ::

use sparse volumes

`--tagged_only` `<boolean>` ::

Only use logical volumes tagged with 'pve-vm-ID'.

`--target` `<string>` ::

iSCSI target.

`--thinpool` `<string>` ::

LVM thin pool LV name.

`--transport` `<rdma | tcp | unix>` ::

Gluster transport: tcp or rdma

`--username` `<string>` ::

RBD Id.

`--vgname` `<string>` ::

Volume group name.

`--volume` `<string>` ::

Glusterfs Volume.

*pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`

Allocate disk images.

`<storage>`: `<string>` ::

The storage identifier.

`<vmid>`: `<integer> (1 - N)` ::

Specify owner VM

`<filename>`: `<string>` ::

The name of the file to create.

`<size>`: `\d+[MG]?` ::

Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)

`--format` `<qcow2 | raw | subvol>` ::

no description available
+
NOTE: Requires option(s): `size`

*pvesm cifsscan* `<server>` `[OPTIONS]`

Scan remote CIFS server.

`<server>`: `<string>` ::

no description available

`--domain` `<string>` ::

no description available

`--password` ::

no description available

`--username` `<string>` ::

no description available

*pvesm export* `<volume> <format> <filename>` `[OPTIONS]`

Export a volume.

`<volume>`: `<string>` ::

Volume identifier

`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::

Export stream format

`<filename>`: `<string>` ::

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` `<boolean>` ('default =' `0`)::

Whether to include intermediate snapshots in the stream

*pvesm extractconfig* `<volume>`

Extract configuration from vzdump backup archive.

`<volume>`: `<string>` ::

Volume identifier

*pvesm free* `<volume>` `[OPTIONS]`

Delete volume

`<volume>`: `<string>` ::

Volume identifier

`--storage` `<string>` ::

The storage identifier.

*pvesm glusterfsscan* `<server>`

Scan remote GlusterFS server.

`<server>`: `<string>` ::

no description available

*pvesm help* `[OPTIONS]`

Get help about specified command.

`--extra-args` `<array>` ::

Shows help for a specific command

`--verbose` `<boolean>` ::

Verbose output format.

*pvesm import* `<volume> <format> <filename>` `[OPTIONS]`

Import a volume.

`<volume>`: `<string>` ::

Volume identifier

`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::

Import stream format

`<filename>`: `<string>` ::

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` `<boolean>` ('default =' `0`)::

Whether the stream includes intermediate snapshots

*pvesm iscsiscan* `--portal <string>` `[OPTIONS]`

Scan remote iSCSI server.

`--portal` `<string>` ::

no description available

*pvesm list* `<storage>` `[OPTIONS]`

List storage content.

`<storage>`: `<string>` ::

The storage identifier.

`--content` `<string>` ::

Only list content of this type.

`--vmid` `<integer> (1 - N)` ::

Only list images for this VM

*pvesm lvmscan*

List local LVM volume groups.

*pvesm lvmthinscan* `<vg>`

List local LVM Thin Pools.

`<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::

no description available

*pvesm nfsscan* `<server>`

Scan remote NFS server.

`<server>`: `<string>` ::

no description available

*pvesm path* `<volume>`

Get filesystem path for specified volume

`<volume>`: `<string>` ::

Volume identifier

*pvesm remove* `<storage>`

Delete storage configuration.

`<storage>`: `<string>` ::

The storage identifier.

*pvesm set* `<storage>` `[OPTIONS]`

Update storage configuration.

`<storage>`: `<string>` ::

The storage identifier.

`--blocksize` `<string>` ::

block size

`--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::

Set bandwidth/io limits various operations.

`--comstar_hg` `<string>` ::

host group for comstar views

`--comstar_tg` `<string>` ::

target group for comstar views

`--content` `<string>` ::

Allowed content types.
+
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.

`--delete` `<string>` ::

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.

`--disable` `<boolean>` ::

Flag to disable the storage.

`--domain` `<string>` ::

CIFS domain.

`--format` `<string>` ::

Default image format.

`--is_mountpoint` `<string>` ('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` `<boolean>` ::

Access rbd through krbd kernel module.

`--maxfiles` `<integer> (0 - N)` ::

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>` ::

IP addresses of monitors (for external clusters).

`--nodes` `<string>` ::

List of cluster node names.

`--nowritecache` `<boolean>` ::

disable write caching on the target

`--options` `<string>` ::

NFS mount options (see 'man nfs')

`--password` ::

Password for CIFS share.

`--pool` `<string>` ::

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.

`--saferemove` `<boolean>` ::

Zero-out data when removing LVs.

`--saferemove_throughput` `<string>` ::

Wipe throughput (cstream -t parameter value).

`--server` `<string>` ::

Server IP or DNS name.

`--server2` `<string>` ::

Backup volfile server IP or DNS name.
+
NOTE: Requires option(s): `server`

`--shared` `<boolean>` ::

Mark storage as shared.

`--smbversion` `<string>` ::

no description available

`--sparse` `<boolean>` ::

use sparse volumes

`--tagged_only` `<boolean>` ::

Only use logical volumes tagged with 'pve-vm-ID'.

`--transport` `<rdma | tcp | unix>` ::

Gluster transport: tcp or rdma

`--username` `<string>` ::

RBD Id.

*pvesm status* `[OPTIONS]`

Get status for all datastores.

`--content` `<string>` ::

Only list stores which support this content type.

`--enabled` `<boolean>` ('default =' `0`)::

Only list stores which are enabled (not disabled in config).

`--format` `<boolean>` ('default =' `0`)::

Include information about formats

`--storage` `<string>` ::

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.

*pvesm zfsscan*

Scan zfs pool list on local node.