pbs: fix password and encryption key file location

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

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

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

Create a new storage.

`<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | 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.

`--datastore` `<string>` ::

Proxmox backup server datastore name.

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

Flag to disable the storage.

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

CIFS domain.

`--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::

Encryption key. Use 'autogen' to generate one automatically without passphrase.

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

NFS export path.

`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::

Certificate SHA 256 fingerprint.

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

Default image format.

`--fuse` `<boolean>` ::

Mount CephFS through FUSE.

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

Always access rbd through krbd kernel module.

`--lio_tpg` `<string>` ::

target portal group for Linux LIO targets

`--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).

`--mountpoint` `<string>` ::

mount point

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

Password for accessing the share/datastore.

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

File system path.

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

Pool.

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

iSCSI portal (IP or DNS name with optional port).

`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::

The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.

`--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` `<2.0 | 2.1 | 3.0>` ::

SMB protocol version

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

use sparse volumes

`--subdir` `<string>` ::

Subdir to mount.

`--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 apiinfo*

Returns APIVER and APIAGE.

*pvesm cifsscan*

An alias for 'pvesm scan cifs'.

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

Used internally to 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

`--delay` `<integer> (1 - 30)` ::

Time to wait for the task to finish. We return 'null' if the task finish within that time.

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

The storage identifier.

*pvesm glusterfsscan*

An alias for 'pvesm scan glusterfs'.

*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]`

Used internally to 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. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection as input. Else, the file is treated as common file.

`--allow-rename` `<boolean>` ('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})` ::

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*

An alias for 'pvesm scan iscsi'.

*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*

An alias for 'pvesm scan lvm'.

*pvesm lvmthinscan*

An alias for 'pvesm scan lvmthin'.

*pvesm nfsscan*

An alias for 'pvesm scan nfs'.

*pvesm path* `<volume>`

Get filesystem path for specified volume

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

Volume identifier

*pvesm prune-backups* `<storage>` `[OPTIONS]`

Prune backups. This is only a wrapper for the proper API endpoints.

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

The storage identifier.

`--dry-run` `<boolean>` ::

Only show what would be pruned, don't delete anything.

`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::

Use these retention options instead of those from the storage configuration.

`--type` `<lxc | qemu>` ::

Either 'qemu' or 'lxc'. Only consider backups for guests of this type.

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

Only consider backups for this guest.

*pvesm remove* `<storage>`

Delete storage configuration.

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

The storage identifier.

*pvesm scan cifs* `<server>` `[OPTIONS]`

Scan remote CIFS server.

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

The server address (name or IP).

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

SMB domain (Workgroup).

`--password` `<password>` ::

User password.

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

User name.

*pvesm scan glusterfs* `<server>`

Scan remote GlusterFS server.

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

The server address (name or IP).

*pvesm scan iscsi* `<portal>`

Scan remote iSCSI server.

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

The iSCSI portal (IP or DNS name with optional port).

*pvesm scan lvm*

List local LVM volume groups.

*pvesm scan lvmthin* `<vg>`

List local LVM Thin Pools.

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

no description available

*pvesm scan nfs* `<server>`

Scan remote NFS server.

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

The server address (name or IP).

*pvesm scan zfs*

Scan zfs pool list on local node.

*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.

`--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::

Encryption key. Use 'autogen' to generate one automatically without passphrase.

`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::

Certificate SHA 256 fingerprint.

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

Default image format.

`--fuse` `<boolean>` ::

Mount CephFS through FUSE.

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

Always access rbd through krbd kernel module.

`--lio_tpg` `<string>` ::

target portal group for Linux LIO targets

`--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).

`--mountpoint` `<string>` ::

mount point

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

Password for accessing the share/datastore.

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

Pool.

`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::

The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.

`--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` `<2.0 | 2.1 | 3.0>` ::

SMB protocol version

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

use sparse volumes

`--subdir` `<string>` ::

Subdir to mount.

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

An alias for 'pvesm scan zfs'.