Create a new storage.
-`<type>` `(dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool)` ::
+`<type>`: `<cephfs | cifs | dir | drbd | fake | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
Storage type.
-`<storage>` `string` ::
+`<storage>`: `<string>` ::
The storage identifier.
-`-authsupported` `string` ::
+`--authsupported` `<string>` ::
Authsupported.
-`-base` `string` ::
+`--base` `<string>` ::
Base volume. This volume is automatically activated.
-`-blocksize` `string` ::
+`--blocksize` `<string>` ::
block size
-`-comstar_hg` `string` ::
+`--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` ::
+`--comstar_tg` `<string>` ::
target group for comstar views
-`-content` `string` ::
+`--content` `<string>` ::
Allowed content types.
+
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
-`-disable` `boolean` ::
+`--disable` `<boolean>` ::
Flag to disable the storage.
-`-export` `string` ::
+`--domain` `<string>` ::
+
+CIFS domain.
+
+`--export` `<string>` ::
NFS export path.
-`-format` `string` ::
+`--format` `<string>` ::
Default image format.
-`-iscsiprovider` `string` ::
+`--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` ::
+`--krbd` `<boolean>` ::
-Access rbd through krbd kernel module.
+Always access rbd through krbd kernel module.
-`-maxfiles` `integer (0 - N)` ::
+`--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.
-`-monhost` `string` ::
+`--mkdir` `<boolean>` ('default =' `yes`)::
+
+Create the directory if it doesn't exist.
+
+`--monhost` `<string>` ::
-Monitors daemon ips.
+IP addresses of monitors (for external clusters).
-`-nodes` `string` ::
+`--nodes` `<string>` ::
List of cluster node names.
-`-nowritecache` `boolean` ::
+`--nowritecache` `<boolean>` ::
disable write caching on the target
-`-options` `string` ::
+`--options` `<string>` ::
NFS mount options (see 'man nfs')
-`-path` `string` ::
+`--password` `<password>` ::
+
+Password for CIFS share.
+
+`--path` `<string>` ::
File system path.
-`-pool` `string` ::
+`--pool` `<string>` ::
Pool.
-`-portal` `string` ::
+`--portal` `<string>` ::
iSCSI portal (IP or DNS name with optional port).
-`-redundancy` `integer (1 - 16)` (default=`2`)::
+`--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` ::
+`--saferemove` `<boolean>` ::
Zero-out data when removing LVs.
-`-saferemove_throughput` `string` ::
+`--saferemove_throughput` `<string>` ::
Wipe throughput (cstream -t parameter value).
-`-server` `string` ::
+`--server` `<string>` ::
Server IP or DNS name.
-`-server2` `string` ::
+`--server2` `<string>` ::
Backup volfile server IP or DNS name.
+
NOTE: Requires option(s): `server`
-`-shared` `boolean` ::
+`--share` `<string>` ::
+
+CIFS share.
+
+`--shared` `<boolean>` ::
Mark storage as shared.
-`-sparse` `boolean` ::
+`--smbversion` `<2.0 | 2.1 | 3.0>` ::
+
+SMB protocol version
+
+`--sparse` `<boolean>` ::
use sparse volumes
-`-target` `string` ::
+`--subdir` `<string>` ::
+
+Subdir to mount.
+
+`--tagged_only` `<boolean>` ::
+
+Only use logical volumes tagged with 'pve-vm-ID'.
+
+`--target` `<string>` ::
iSCSI target.
-`-thinpool` `string` ::
+`--thinpool` `<string>` ::
LVM thin pool LV name.
-`-transport` `(rdma | tcp | unix)` ::
+`--transport` `<rdma | tcp | unix>` ::
Gluster transport: tcp or rdma
-`-username` `string` ::
+`--username` `<string>` ::
RBD Id.
-`-vgname` `string` ::
+`--vgname` `<string>` ::
Volume group name.
-`-volume` `string` ::
+`--volume` `<string>` ::
Glusterfs Volume.
-
-
-
*pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
Allocate disk images.
-`<storage>` `string` ::
+`<storage>`: `<string>` ::
The storage identifier.
-`<vmid>` `integer (1 - N)` ::
+`<vmid>`: `<integer> (1 - N)` ::
Specify owner VM
-`<filename>` `string` ::
+`<filename>`: `<string>` ::
The name of the file to create.
-`<size>` `\d+[MG]?` ::
+`<size>`: `\d+[MG]?` ::
Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
-`-format` `(qcow2 | raw | subvol)` ::
+`--format` `<qcow2 | raw | subvol>` ::
no description available
+
NOTE: Requires option(s): `size`
+*pvesm cifsscan*
+An alias for 'pvesm scan cifs'.
-*pvesm free* `<volume>` `[OPTIONS]`
+*pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
-Delete volume
+Export a volume.
-`<volume>` `string` ::
+`<volume>`: `<string>` ::
Volume identifier
-`-storage` `string` ::
+`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
-The storage identifier.
+Export stream format
+`<filename>`: `<string>` ::
+Destination file name
+`--base` `(?^:[a-z0-9_\-]{1,40})` ::
-*pvesm glusterfsscan* `<server>`
+Snapshot to start an incremental stream from
-Scan remote GlusterFS server.
+`--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
-`<server>` `string` ::
+Snapshot to export
-no description available
+`--with-snapshots` `<boolean>` ('default =' `0`)::
+Whether to include intermediate snapshots in the stream
+*pvesm extractconfig* `<volume>`
+Extract configuration from vzdump backup archive.
-*pvesm help* `[<cmd>]` `[OPTIONS]`
+`<volume>`: `<string>` ::
+
+Volume identifier
+
+*pvesm free* `<volume>` `[OPTIONS]`
+
+Delete volume
+
+`<volume>`: `<string>` ::
+
+Volume identifier
+
+`--storage` `<string>` ::
+
+The storage identifier.
+
+*pvesm glusterfsscan*
+
+An alias for 'pvesm scan glusterfs'.
+
+*pvesm help* `[OPTIONS]`
Get help about specified command.
-`<cmd>` `string` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
-`-verbose` `boolean` ::
+`--verbose` `<boolean>` ::
Verbose output format.
+*pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
+
+Import a volume.
+`<volume>`: `<string>` ::
+Volume identifier
-*pvesm iscsiscan* `-portal <string>` `[OPTIONS]`
+`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
-Scan remote iSCSI server.
+Import stream format
-`-portal` `string` ::
+`<filename>`: `<string>` ::
-no description available
+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*
+An alias for 'pvesm scan iscsi'.
*pvesm list* `<storage>` `[OPTIONS]`
List storage content.
-`<storage>` `string` ::
+`<storage>`: `<string>` ::
The storage identifier.
-`-content` `string` ::
+`--content` `<string>` ::
Only list content of this type.
-`-vmid` `integer (1 - N)` ::
+`--vmid` `<integer> (1 - N)` ::
Only list images for this VM
+*pvesm lvmscan*
+An alias for 'pvesm scan lvm'.
+*pvesm lvmthinscan*
-*pvesm lvmscan*
+An alias for 'pvesm scan lvmthin'.
-List local LVM volume groups.
+*pvesm nfsscan*
+An alias for 'pvesm scan nfs'.
+*pvesm path* `<volume>`
-*pvesm lvmthinscan* `<vg>`
+Get filesystem path for specified volume
-List local LVM Thin Pools.
+`<volume>`: `<string>` ::
+
+Volume identifier
-`<vg>` `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
+*pvesm remove* `<storage>`
-no description available
+Delete storage configuration.
+`<storage>`: `<string>` ::
+The storage identifier.
-*pvesm nfsscan* `<server>`
+*pvesm scan cifs* `<server>` `[OPTIONS]`
-Scan remote NFS server.
+Scan remote CIFS server.
-`<server>` `string` ::
+`<server>`: `<string>` ::
-no description available
+The server address (name or IP).
+`--domain` `<string>` ::
+SMB domain (Workgroup).
+`--password` `<password>` ::
-*pvesm path* `<volume>`
+User password.
-Get filesystem path for specified volume
+`--username` `<string>` ::
-`<volume>` `string` ::
+User name.
-Volume identifier
+*pvesm scan glusterfs* `<server>`
+Scan remote GlusterFS server.
+`<server>`: `<string>` ::
+The server address (name or IP).
-*pvesm remove* `<storage>`
+*pvesm scan iscsi* `<portal>`
-Delete storage configuration.
+Scan remote iSCSI server.
-`<storage>` `string` ::
+`<portal>`: `<string>` ::
-The storage identifier.
+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` ::
+`<storage>`: `<string>` ::
The storage identifier.
-`-blocksize` `string` ::
+`--blocksize` `<string>` ::
block size
-`-comstar_hg` `string` ::
+`--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` ::
+`--comstar_tg` `<string>` ::
target group for comstar views
-`-content` `string` ::
+`--content` `<string>` ::
Allowed content types.
+
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
-`-delete` `string` ::
+`--delete` `<string>` ::
A list of settings you want to delete.
-`-digest` `string` ::
+`--digest` `<string>` ::
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
-`-disable` `boolean` ::
+`--disable` `<boolean>` ::
Flag to disable the storage.
-`-format` `string` ::
+`--domain` `<string>` ::
+
+CIFS domain.
+
+`--format` `<string>` ::
Default image format.
-`-krbd` `boolean` ::
+`--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.
-Access rbd through krbd kernel module.
+`--lio_tpg` `<string>` ::
-`-maxfiles` `integer (0 - N)` ::
+target portal group for Linux LIO targets
+
+`--maxfiles` `<integer> (0 - N)` ::
Maximal number of backup files per VM. Use '0' for unlimted.
-`-nodes` `string` ::
+`--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` ::
+`--nowritecache` `<boolean>` ::
disable write caching on the target
-`-options` `string` ::
+`--options` `<string>` ::
NFS mount options (see 'man nfs')
-`-pool` `string` ::
+`--password` `<string>` ::
+
+Password for CIFS share.
+
+`--pool` `<string>` ::
Pool.
-`-redundancy` `integer (1 - 16)` (default=`2`)::
+`--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` ::
+`--saferemove` `<boolean>` ::
Zero-out data when removing LVs.
-`-saferemove_throughput` `string` ::
+`--saferemove_throughput` `<string>` ::
Wipe throughput (cstream -t parameter value).
-`-server` `string` ::
+`--server` `<string>` ::
Server IP or DNS name.
-`-server2` `string` ::
+`--server2` `<string>` ::
Backup volfile server IP or DNS name.
+
NOTE: Requires option(s): `server`
-`-shared` `boolean` ::
+`--shared` `<boolean>` ::
Mark storage as shared.
-`-sparse` `boolean` ::
+`--smbversion` `<2.0 | 2.1 | 3.0>` ::
+
+SMB protocol version
+
+`--sparse` `<boolean>` ::
use sparse volumes
-`-transport` `(rdma | tcp | unix)` ::
+`--subdir` `<string>` ::
-Gluster transport: tcp or rdma
+Subdir to mount.
-`-username` `string` ::
+`--tagged_only` `<boolean>` ::
-RBD Id.
+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` ::
+`--content` `<string>` ::
Only list stores which support this content type.
-`-enabled` `boolean` (default=`0`)::
+`--enabled` `<boolean>` ('default =' `0`)::
Only list stores which are enabled (not disabled in config).
-`-storage` `string` ::
+`--format` `<boolean>` ('default =' `0`)::
-Only list status for specified storage
+Include information about formats
-`-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.
+`--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.
-
-
+An alias for 'pvesm scan zfs'.
projects / pve-docs.git / blobdiff