Create a new storage.
-`<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
+`<type>`: `<btrfs | cephfs | cifs | dir | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` ::
Storage type.
+
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.
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.
`--krbd` `<boolean>` ::
-Access rbd through krbd kernel module.
+Always access rbd through krbd kernel module.
`--lio_tpg` `<string>` ::
target portal group for Linux LIO targets
+`--master-pubkey` `a file containing a PEM-formatted master public key` ::
+
+Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.
+
`--maxfiles` `<integer> (0 - N)` ::
-Maximal number of backup files per VM. Use '0' for unlimted.
+Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.
`--mkdir` `<boolean>` ('default =' `yes`)::
IP addresses of monitors (for external clusters).
+`--mountpoint` `<string>` ::
+
+mount point
+
+`--namespace` `<string>` ::
+
+RBD Namespace.
+
+`--nocow` `<boolean>` ('default =' `0`)::
+
+Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system.
+
`--nodes` `<string>` ::
List of cluster node names.
`--password` `<password>` ::
-Password for CIFS share.
+Password for accessing the share/datastore.
`--path` `<string>` ::
Pool.
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+For non default port.
+
`--portal` `<string>` ::
iSCSI portal (IP or DNS name with optional port).
-`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
+`--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
-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 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.
`--saferemove` `<boolean>` ::
+
NOTE: Requires option(s): `size`
-*pvesm cifsscan* `<server>` `[OPTIONS]`
-
-Scan remote CIFS server.
-
-`<server>`: `<string>` ::
-
-The server address (name or IP).
-
-`--domain` `<string>` ::
+*pvesm apiinfo*
-SMB domain (Workgroup).
+Returns APIVER and APIAGE.
-`--password` `<password>` ::
+*pvesm cifsscan*
-User password.
-
-`--username` `<string>` ::
-
-User name.
+An alias for 'pvesm scan cifs'.
*pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
-Export a volume.
+Used internally to export a volume.
`<volume>`: `<string>` ::
Volume identifier
-`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
+`<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
Export stream format
Destination file name
-`--base` `(?^:[a-z0-9_\-]{1,40})` ::
+`--base` `(?^i:[a-z0-9_\-]{1,40})` ::
Snapshot to start an incremental stream from
-`--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
+`--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
Snapshot to export
+`--snapshot-list` `<string>` ::
+
+Ordered list of snapshots to transfer
+
`--with-snapshots` `<boolean>` ('default =' `0`)::
Whether to include intermediate snapshots in the stream
Volume identifier
-`--storage` `<string>` ::
+`--delay` `<integer> (1 - 30)` ::
-The storage identifier.
+Time to wait for the task to finish. We return 'null' if the task finish within that time.
-*pvesm glusterfsscan* `<server>`
+`--storage` `<string>` ::
-Scan remote GlusterFS server.
+The storage identifier.
-`<server>`: `<string>` ::
+*pvesm glusterfsscan*
-The server address (name or IP).
+An alias for 'pvesm scan glusterfs'.
*pvesm help* `[OPTIONS]`
*pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
-Import a volume.
+Used internally to import a volume.
`<volume>`: `<string>` ::
Volume identifier
-`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
+`<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
Import stream format
`<filename>`: `<string>` ::
-Source file name
+Source file name. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection, the unix://PATH-TO-SOCKET format a UNIX socket 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` `(?^i:[a-z0-9_\-]{1,40})` ::
Base snapshot of an incremental stream
-`--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
+`--delete-snapshot` `(?^i:[a-z0-9_\-]{1,80})` ::
A snapshot to delete on success
+`--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
+
+The current-state snapshot if the stream contains snapshots
+
`--with-snapshots` `<boolean>` ('default =' `0`)::
Whether the stream includes intermediate snapshots
-*pvesm iscsiscan* `<portal>`
-
-Scan remote iSCSI server.
+*pvesm iscsiscan*
-`<portal>`: `<string>` ::
-
-The iSCSI portal (IP or DNS name with optional port).
+An alias for 'pvesm scan iscsi'.
*pvesm list* `<storage>` `[OPTIONS]`
*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. Only those using the standard naming scheme are considered.
+If no keep options are specified, those from the storage configuration are
+used.
+
+`<storage>`: `<string>` ::
+
+The storage identifier.
+
+`--dry-run` `<boolean>` ::
+
+Only show what would be pruned, don't delete anything.
+
+`--keep-all` `<boolean>` ::
+
+Keep all backups. Conflicts with the other options when true.
+
+`--keep-daily` `<N>` ::
+
+Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
+
+`--keep-hourly` `<N>` ::
+
+Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
+
+`--keep-last` `<N>` ::
+
+Keep the last <N> backups.
+
+`--keep-monthly` `<N>` ::
+
+Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
+
+`--keep-weekly` `<N>` ::
+
+Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
+
+`--keep-yearly` `<N>` ::
+
+Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
+
+`--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 lvmthinscan* `<vg>`
+*pvesm scan lvmthin* `<vg>`
List local LVM Thin Pools.
no description available
-*pvesm nfsscan* `<server>`
+*pvesm scan nfs* `<server>`
Scan remote NFS server.
The server address (name or IP).
-*pvesm path* `<volume>`
+*pvesm scan pbs* `<server> <username> --password <string>` `[OPTIONS]` `[FORMAT_OPTIONS]`
-Get filesystem path for specified volume
+Scan remote Proxmox Backup Server.
-`<volume>`: `<string>` ::
+`<server>`: `<string>` ::
-Volume identifier
+The server address (name or IP).
-*pvesm remove* `<storage>`
+`<username>`: `<string>` ::
-Delete storage configuration.
+User-name or API token-ID.
-`<storage>`: `<string>` ::
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
-The storage identifier.
+Certificate SHA 256 fingerprint.
+
+`--password` `<string>` ::
+
+User password or API token secret.
+
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+Optional port.
+
+*pvesm scan zfs*
+
+Scan zfs pool list on local node.
*pvesm set* `<storage>` `[OPTIONS]`
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.
`--krbd` `<boolean>` ::
-Access rbd through krbd kernel module.
+Always access rbd through krbd kernel module.
`--lio_tpg` `<string>` ::
target portal group for Linux LIO targets
+`--master-pubkey` `a file containing a PEM-formatted master public key` ::
+
+Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.
+
`--maxfiles` `<integer> (0 - N)` ::
-Maximal number of backup files per VM. Use '0' for unlimted.
+Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.
`--mkdir` `<boolean>` ('default =' `yes`)::
IP addresses of monitors (for external clusters).
+`--mountpoint` `<string>` ::
+
+mount point
+
+`--namespace` `<string>` ::
+
+RBD Namespace.
+
+`--nocow` `<boolean>` ('default =' `0`)::
+
+Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system.
+
`--nodes` `<string>` ::
List of cluster node names.
NFS mount options (see 'man nfs')
-`--password` `<string>` ::
+`--password` `<password>` ::
-Password for CIFS share.
+Password for accessing the share/datastore.
`--pool` `<string>` ::
Pool.
-`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+For non default port.
-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.
+`--prune-backups` `[keep-all=<1|0>] [,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.
`--saferemove` `<boolean>` ::
*pvesm zfsscan*
-Scan zfs pool list on local node.
+An alias for 'pvesm scan zfs'.
projects / pve-docs.git / blobdiff