X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvesm.1-synopsis.adoc;h=5a71906311410773811026056d8fab464ad89d78;hp=df90d7c26640878e390b0b107d73164c92574e9e;hb=7d6078845fa6a3bd308c7dc843273e56be33f315;hpb=5d9c884c7b3f4980abbd4cbe91ea588a03266485 diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index df90d7c..5a71906 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -4,7 +4,7 @@ Create a new storage. -``: `` :: +``: `` :: Storage type. @@ -12,153 +12,182 @@ Storage type. The storage identifier. -`-authsupported` `` :: +`--authsupported` `` :: Authsupported. -`-base` `` :: +`--base` `` :: Base volume. This volume is automatically activated. -`-blocksize` `` :: +`--blocksize` `` :: block size -`-comstar_hg` `` :: +`--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: + +Set bandwidth/io limits various operations. + +`--comstar_hg` `` :: host group for comstar views -`-comstar_tg` `` :: +`--comstar_tg` `` :: target group for comstar views -`-content` `` :: +`--content` `` :: Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. -`-disable` `` :: +`--disable` `` :: Flag to disable the storage. -`-export` `` :: +`--domain` `` :: + +CIFS domain. + +`--export` `` :: NFS export path. -`-format` `` :: +`--format` `` :: Default image format. -`-is_mountpoint` `` ('default =' `no`):: +`--fuse` `` :: -Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. +Mount CephFS through FUSE. -`-iscsiprovider` `` :: +`--is_mountpoint` `` ('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` `` :: iscsi provider -`-krbd` `` :: +`--krbd` `` :: + +Always access rbd through krbd kernel module. + +`--lio_tpg` `` :: -Access rbd through krbd kernel module. +target portal group for Linux LIO targets -`-maxfiles` ` (0 - N)` :: +`--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. -`-mkdir` `` ('default =' `yes`):: +`--mkdir` `` ('default =' `yes`):: Create the directory if it doesn't exist. -`-monhost` `` :: +`--monhost` `` :: -Monitors daemon ips. +IP addresses of monitors (for external clusters). -`-nodes` `` :: +`--nodes` `` :: List of cluster node names. -`-nowritecache` `` :: +`--nowritecache` `` :: disable write caching on the target -`-options` `` :: +`--options` `` :: NFS mount options (see 'man nfs') -`-path` `` :: +`--password` `` :: + +Password for CIFS share. + +`--path` `` :: File system path. -`-pool` `` :: +`--pool` `` :: Pool. -`-portal` `` :: +`--portal` `` :: iSCSI portal (IP or DNS name with optional port). -`-redundancy` ` (1 - 16)` ('default =' `2`):: +`--redundancy` ` (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` `` :: +`--saferemove` `` :: Zero-out data when removing LVs. -`-saferemove_throughput` `` :: +`--saferemove_throughput` `` :: Wipe throughput (cstream -t parameter value). -`-server` `` :: +`--server` `` :: Server IP or DNS name. -`-server2` `` :: +`--server2` `` :: Backup volfile server IP or DNS name. + NOTE: Requires option(s): `server` -`-shared` `` :: +`--share` `` :: + +CIFS share. + +`--shared` `` :: Mark storage as shared. -`-sparse` `` :: +`--smbversion` `<2.0 | 2.1 | 3.0>` :: + +SMB protocol version + +`--sparse` `` :: use sparse volumes -`-tagged_only` `` :: +`--subdir` `` :: + +Subdir to mount. + +`--tagged_only` `` :: Only use logical volumes tagged with 'pve-vm-ID'. -`-target` `` :: +`--target` `` :: iSCSI target. -`-thinpool` `` :: +`--thinpool` `` :: LVM thin pool LV name. -`-transport` `` :: +`--transport` `` :: Gluster transport: tcp or rdma -`-username` `` :: +`--username` `` :: RBD Id. -`-vgname` `` :: +`--vgname` `` :: Volume group name. -`-volume` `` :: +`--volume` `` :: Glusterfs Volume. - - - *pvesm alloc* ` ` `[OPTIONS]` Allocate disk images. @@ -179,14 +208,15 @@ The name of the file to create. Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) -`-format` `` :: +`--format` `` :: no description available + NOTE: Requires option(s): `size` +*pvesm cifsscan* - +An alias for 'pvesm scan cifs'. *pvesm export* ` ` `[OPTIONS]` @@ -204,20 +234,18 @@ Export stream format Destination file name -`-base` `(?^:[a-z0-9_\-]{1,40})` :: +`--base` `(?^:[a-z0-9_\-]{1,40})` :: Snapshot to start an incremental stream from -`-snapshot` `(?^:[a-z0-9_\-]{1,40})` :: +`--snapshot` `(?^:[a-z0-9_\-]{1,40})` :: Snapshot to export -`-with-snapshots` `` ('default =' `0`):: +`--with-snapshots` `` ('default =' `0`):: Whether to include intermediate snapshots in the stream - - *pvesm extractconfig* `` Extract configuration from vzdump backup archive. @@ -226,9 +254,6 @@ Extract configuration from vzdump backup archive. Volume identifier - - - *pvesm free* `` `[OPTIONS]` Delete volume @@ -237,39 +262,26 @@ Delete volume Volume identifier -`-storage` `` :: +`--storage` `` :: The storage identifier. +*pvesm glusterfsscan* +An alias for 'pvesm scan glusterfs'. - -*pvesm glusterfsscan* `` - -Scan remote GlusterFS server. - -``: `` :: - -no description available - - - - -*pvesm help* `[]` `[OPTIONS]` +*pvesm help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command -`-verbose` `` :: +`--verbose` `` :: Verbose output format. - - - *pvesm import* ` ` `[OPTIONS]` Import a volume. @@ -286,98 +298,125 @@ Import stream format Source file name -`-base` `(?^:[a-z0-9_\-]{1,40})` :: +`--base` `(?^:[a-z0-9_\-]{1,40})` :: Base snapshot of an incremental stream -`-delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` :: +`--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` :: A snapshot to delete on success -`-with-snapshots` `` ('default =' `0`):: +`--with-snapshots` `` ('default =' `0`):: Whether the stream includes intermediate snapshots +*pvesm iscsiscan* +An alias for 'pvesm scan iscsi'. +*pvesm list* `` `[OPTIONS]` -*pvesm iscsiscan* `-portal ` `[OPTIONS]` +List storage content. -Scan remote iSCSI server. +``: `` :: -`-portal` `` :: +The storage identifier. -no description available +`--content` `` :: +Only list content of this type. +`--vmid` ` (1 - N)` :: +Only list images for this VM -*pvesm list* `` `[OPTIONS]` +*pvesm lvmscan* -List storage content. +An alias for 'pvesm scan lvm'. -``: `` :: +*pvesm lvmthinscan* -The storage identifier. +An alias for 'pvesm scan lvmthin'. -`-content` `` :: +*pvesm nfsscan* -Only list content of this type. +An alias for 'pvesm scan nfs'. -`-vmid` ` (1 - N)` :: +*pvesm path* `` -Only list images for this VM +Get filesystem path for specified volume +``: `` :: +Volume identifier +*pvesm remove* `` -*pvesm lvmscan* +Delete storage configuration. -List local LVM volume groups. +``: `` :: +The storage identifier. +*pvesm scan cifs* `` `[OPTIONS]` -*pvesm lvmthinscan* `` +Scan remote CIFS server. -List local LVM Thin Pools. +``: `` :: -``: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: +The server address (name or IP). -no description available +`--domain` `` :: +SMB domain (Workgroup). +`--password` `` :: -*pvesm nfsscan* `` +User password. -Scan remote NFS server. +`--username` `` :: + +User name. + +*pvesm scan glusterfs* `` + +Scan remote GlusterFS server. ``: `` :: -no description available +The server address (name or IP). +*pvesm scan iscsi* `` +Scan remote iSCSI server. +``: `` :: -*pvesm path* `` +The iSCSI portal (IP or DNS name with optional port). -Get filesystem path for specified volume +*pvesm scan lvm* -``: `` :: +List local LVM volume groups. -Volume identifier +*pvesm scan lvmthin* `` +List local LVM Thin Pools. +``: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` :: +no description available -*pvesm remove* `` +*pvesm scan nfs* `` -Delete storage configuration. +Scan remote NFS server. -``: `` :: +``: `` :: -The storage identifier. +The server address (name or IP). +*pvesm scan zfs* +Scan zfs pool list on local node. *pvesm set* `` `[OPTIONS]` @@ -387,144 +426,172 @@ Update storage configuration. The storage identifier. -`-blocksize` `` :: +`--blocksize` `` :: block size -`-comstar_hg` `` :: +`--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: + +Set bandwidth/io limits various operations. + +`--comstar_hg` `` :: host group for comstar views -`-comstar_tg` `` :: +`--comstar_tg` `` :: target group for comstar views -`-content` `` :: +`--content` `` :: Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-disable` `` :: +`--disable` `` :: Flag to disable the storage. -`-format` `` :: +`--domain` `` :: + +CIFS domain. + +`--format` `` :: Default image format. -`-is_mountpoint` `` ('default =' `no`):: +`--fuse` `` :: + +Mount CephFS through FUSE. + +`--is_mountpoint` `` ('default =' `no`):: -Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. +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` `` :: +`--krbd` `` :: -Access rbd through krbd kernel module. +Always access rbd through krbd kernel module. -`-maxfiles` ` (0 - N)` :: +`--lio_tpg` `` :: + +target portal group for Linux LIO targets + +`--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. -`-mkdir` `` ('default =' `yes`):: +`--mkdir` `` ('default =' `yes`):: Create the directory if it doesn't exist. -`-nodes` `` :: +`--monhost` `` :: + +IP addresses of monitors (for external clusters). + +`--nodes` `` :: List of cluster node names. -`-nowritecache` `` :: +`--nowritecache` `` :: disable write caching on the target -`-options` `` :: +`--options` `` :: NFS mount options (see 'man nfs') -`-pool` `` :: +`--password` `` :: + +Password for CIFS share. + +`--pool` `` :: Pool. -`-redundancy` ` (1 - 16)` ('default =' `2`):: +`--redundancy` ` (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` `` :: +`--saferemove` `` :: Zero-out data when removing LVs. -`-saferemove_throughput` `` :: +`--saferemove_throughput` `` :: Wipe throughput (cstream -t parameter value). -`-server` `` :: +`--server` `` :: Server IP or DNS name. -`-server2` `` :: +`--server2` `` :: Backup volfile server IP or DNS name. + NOTE: Requires option(s): `server` -`-shared` `` :: +`--shared` `` :: Mark storage as shared. -`-sparse` `` :: +`--smbversion` `<2.0 | 2.1 | 3.0>` :: + +SMB protocol version + +`--sparse` `` :: use sparse volumes -`-tagged_only` `` :: +`--subdir` `` :: + +Subdir to mount. + +`--tagged_only` `` :: Only use logical volumes tagged with 'pve-vm-ID'. -`-transport` `` :: +`--transport` `` :: Gluster transport: tcp or rdma -`-username` `` :: +`--username` `` :: RBD Id. - - - *pvesm status* `[OPTIONS]` Get status for all datastores. -`-content` `` :: +`--content` `` :: Only list stores which support this content type. -`-enabled` `` ('default =' `0`):: +`--enabled` `` ('default =' `0`):: Only list stores which are enabled (not disabled in config). -`-storage` `` :: - -Only list status for specified storage +`--format` `` ('default =' `0`):: -`-target` `` :: +Include information about formats -If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. +`--storage` `` :: +Only list status for specified storage +`--target` `` :: +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'.