You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

610 lines
11KB

  1. *pvesm* `<COMMAND> [ARGS] [OPTIONS]`
  2. *pvesm add* `<type> <storage>` `[OPTIONS]`
  3. Create a new storage.
  4. `<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | zfs | zfspool>` ::
  5. Storage type.
  6. `<storage>`: `<string>` ::
  7. The storage identifier.
  8. `--authsupported` `<string>` ::
  9. Authsupported.
  10. `--base` `<string>` ::
  11. Base volume. This volume is automatically activated.
  12. `--blocksize` `<string>` ::
  13. block size
  14. `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
  15. Set bandwidth/io limits various operations.
  16. `--comstar_hg` `<string>` ::
  17. host group for comstar views
  18. `--comstar_tg` `<string>` ::
  19. target group for comstar views
  20. `--content` `<string>` ::
  21. Allowed content types.
  22. +
  23. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
  24. `--disable` `<boolean>` ::
  25. Flag to disable the storage.
  26. `--domain` `<string>` ::
  27. CIFS domain.
  28. `--export` `<string>` ::
  29. NFS export path.
  30. `--format` `<string>` ::
  31. Default image format.
  32. `--fuse` `<boolean>` ::
  33. Mount CephFS through FUSE.
  34. `--is_mountpoint` `<string>` ('default =' `no`)::
  35. 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.
  36. `--iscsiprovider` `<string>` ::
  37. iscsi provider
  38. `--krbd` `<boolean>` ::
  39. Always access rbd through krbd kernel module.
  40. `--lio_tpg` `<string>` ::
  41. target portal group for Linux LIO targets
  42. `--maxfiles` `<integer> (0 - N)` ::
  43. Maximal number of backup files per VM. Use '0' for unlimted.
  44. `--mkdir` `<boolean>` ('default =' `yes`)::
  45. Create the directory if it doesn't exist.
  46. `--monhost` `<string>` ::
  47. IP addresses of monitors (for external clusters).
  48. `--mountpoint` `<string>` ::
  49. mount point
  50. `--nodes` `<string>` ::
  51. List of cluster node names.
  52. `--nowritecache` `<boolean>` ::
  53. disable write caching on the target
  54. `--options` `<string>` ::
  55. NFS mount options (see 'man nfs')
  56. `--password` `<password>` ::
  57. Password for CIFS share.
  58. `--path` `<string>` ::
  59. File system path.
  60. `--pool` `<string>` ::
  61. Pool.
  62. `--portal` `<string>` ::
  63. iSCSI portal (IP or DNS name with optional port).
  64. `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
  65. 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.
  66. `--saferemove` `<boolean>` ::
  67. Zero-out data when removing LVs.
  68. `--saferemove_throughput` `<string>` ::
  69. Wipe throughput (cstream -t parameter value).
  70. `--server` `<string>` ::
  71. Server IP or DNS name.
  72. `--server2` `<string>` ::
  73. Backup volfile server IP or DNS name.
  74. +
  75. NOTE: Requires option(s): `server`
  76. `--share` `<string>` ::
  77. CIFS share.
  78. `--shared` `<boolean>` ::
  79. Mark storage as shared.
  80. `--smbversion` `<2.0 | 2.1 | 3.0>` ::
  81. SMB protocol version
  82. `--sparse` `<boolean>` ::
  83. use sparse volumes
  84. `--subdir` `<string>` ::
  85. Subdir to mount.
  86. `--tagged_only` `<boolean>` ::
  87. Only use logical volumes tagged with 'pve-vm-ID'.
  88. `--target` `<string>` ::
  89. iSCSI target.
  90. `--thinpool` `<string>` ::
  91. LVM thin pool LV name.
  92. `--transport` `<rdma | tcp | unix>` ::
  93. Gluster transport: tcp or rdma
  94. `--username` `<string>` ::
  95. RBD Id.
  96. `--vgname` `<string>` ::
  97. Volume group name.
  98. `--volume` `<string>` ::
  99. Glusterfs Volume.
  100. *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
  101. Allocate disk images.
  102. `<storage>`: `<string>` ::
  103. The storage identifier.
  104. `<vmid>`: `<integer> (1 - N)` ::
  105. Specify owner VM
  106. `<filename>`: `<string>` ::
  107. The name of the file to create.
  108. `<size>`: `\d+[MG]?` ::
  109. Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
  110. `--format` `<qcow2 | raw | subvol>` ::
  111. no description available
  112. +
  113. NOTE: Requires option(s): `size`
  114. *pvesm cifsscan*
  115. An alias for 'pvesm scan cifs'.
  116. *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
  117. Export a volume.
  118. `<volume>`: `<string>` ::
  119. Volume identifier
  120. `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
  121. Export stream format
  122. `<filename>`: `<string>` ::
  123. Destination file name
  124. `--base` `(?^:[a-z0-9_\-]{1,40})` ::
  125. Snapshot to start an incremental stream from
  126. `--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
  127. Snapshot to export
  128. `--with-snapshots` `<boolean>` ('default =' `0`)::
  129. Whether to include intermediate snapshots in the stream
  130. *pvesm extractconfig* `<volume>`
  131. Extract configuration from vzdump backup archive.
  132. `<volume>`: `<string>` ::
  133. Volume identifier
  134. *pvesm free* `<volume>` `[OPTIONS]`
  135. Delete volume
  136. `<volume>`: `<string>` ::
  137. Volume identifier
  138. `--delay` `<integer> (1 - 30)` ::
  139. Time to wait for the task to finish. We return 'null' if the task finish within that time.
  140. `--storage` `<string>` ::
  141. The storage identifier.
  142. *pvesm glusterfsscan*
  143. An alias for 'pvesm scan glusterfs'.
  144. *pvesm help* `[OPTIONS]`
  145. Get help about specified command.
  146. `--extra-args` `<array>` ::
  147. Shows help for a specific command
  148. `--verbose` `<boolean>` ::
  149. Verbose output format.
  150. *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
  151. Import a volume.
  152. `<volume>`: `<string>` ::
  153. Volume identifier
  154. `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
  155. Import stream format
  156. `<filename>`: `<string>` ::
  157. 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.
  158. `--base` `(?^:[a-z0-9_\-]{1,40})` ::
  159. Base snapshot of an incremental stream
  160. `--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
  161. A snapshot to delete on success
  162. `--with-snapshots` `<boolean>` ('default =' `0`)::
  163. Whether the stream includes intermediate snapshots
  164. *pvesm iscsiscan*
  165. An alias for 'pvesm scan iscsi'.
  166. *pvesm list* `<storage>` `[OPTIONS]`
  167. List storage content.
  168. `<storage>`: `<string>` ::
  169. The storage identifier.
  170. `--content` `<string>` ::
  171. Only list content of this type.
  172. `--vmid` `<integer> (1 - N)` ::
  173. Only list images for this VM
  174. *pvesm lvmscan*
  175. An alias for 'pvesm scan lvm'.
  176. *pvesm lvmthinscan*
  177. An alias for 'pvesm scan lvmthin'.
  178. *pvesm nfsscan*
  179. An alias for 'pvesm scan nfs'.
  180. *pvesm path* `<volume>`
  181. Get filesystem path for specified volume
  182. `<volume>`: `<string>` ::
  183. Volume identifier
  184. *pvesm remove* `<storage>`
  185. Delete storage configuration.
  186. `<storage>`: `<string>` ::
  187. The storage identifier.
  188. *pvesm scan cifs* `<server>` `[OPTIONS]`
  189. Scan remote CIFS server.
  190. `<server>`: `<string>` ::
  191. The server address (name or IP).
  192. `--domain` `<string>` ::
  193. SMB domain (Workgroup).
  194. `--password` `<password>` ::
  195. User password.
  196. `--username` `<string>` ::
  197. User name.
  198. *pvesm scan glusterfs* `<server>`
  199. Scan remote GlusterFS server.
  200. `<server>`: `<string>` ::
  201. The server address (name or IP).
  202. *pvesm scan iscsi* `<portal>`
  203. Scan remote iSCSI server.
  204. `<portal>`: `<string>` ::
  205. The iSCSI portal (IP or DNS name with optional port).
  206. *pvesm scan lvm*
  207. List local LVM volume groups.
  208. *pvesm scan lvmthin* `<vg>`
  209. List local LVM Thin Pools.
  210. `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
  211. no description available
  212. *pvesm scan nfs* `<server>`
  213. Scan remote NFS server.
  214. `<server>`: `<string>` ::
  215. The server address (name or IP).
  216. *pvesm scan zfs*
  217. Scan zfs pool list on local node.
  218. *pvesm set* `<storage>` `[OPTIONS]`
  219. Update storage configuration.
  220. `<storage>`: `<string>` ::
  221. The storage identifier.
  222. `--blocksize` `<string>` ::
  223. block size
  224. `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
  225. Set bandwidth/io limits various operations.
  226. `--comstar_hg` `<string>` ::
  227. host group for comstar views
  228. `--comstar_tg` `<string>` ::
  229. target group for comstar views
  230. `--content` `<string>` ::
  231. Allowed content types.
  232. +
  233. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
  234. `--delete` `<string>` ::
  235. A list of settings you want to delete.
  236. `--digest` `<string>` ::
  237. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
  238. `--disable` `<boolean>` ::
  239. Flag to disable the storage.
  240. `--domain` `<string>` ::
  241. CIFS domain.
  242. `--format` `<string>` ::
  243. Default image format.
  244. `--fuse` `<boolean>` ::
  245. Mount CephFS through FUSE.
  246. `--is_mountpoint` `<string>` ('default =' `no`)::
  247. 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.
  248. `--krbd` `<boolean>` ::
  249. Always access rbd through krbd kernel module.
  250. `--lio_tpg` `<string>` ::
  251. target portal group for Linux LIO targets
  252. `--maxfiles` `<integer> (0 - N)` ::
  253. Maximal number of backup files per VM. Use '0' for unlimted.
  254. `--mkdir` `<boolean>` ('default =' `yes`)::
  255. Create the directory if it doesn't exist.
  256. `--monhost` `<string>` ::
  257. IP addresses of monitors (for external clusters).
  258. `--mountpoint` `<string>` ::
  259. mount point
  260. `--nodes` `<string>` ::
  261. List of cluster node names.
  262. `--nowritecache` `<boolean>` ::
  263. disable write caching on the target
  264. `--options` `<string>` ::
  265. NFS mount options (see 'man nfs')
  266. `--password` `<string>` ::
  267. Password for CIFS share.
  268. `--pool` `<string>` ::
  269. Pool.
  270. `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
  271. 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.
  272. `--saferemove` `<boolean>` ::
  273. Zero-out data when removing LVs.
  274. `--saferemove_throughput` `<string>` ::
  275. Wipe throughput (cstream -t parameter value).
  276. `--server` `<string>` ::
  277. Server IP or DNS name.
  278. `--server2` `<string>` ::
  279. Backup volfile server IP or DNS name.
  280. +
  281. NOTE: Requires option(s): `server`
  282. `--shared` `<boolean>` ::
  283. Mark storage as shared.
  284. `--smbversion` `<2.0 | 2.1 | 3.0>` ::
  285. SMB protocol version
  286. `--sparse` `<boolean>` ::
  287. use sparse volumes
  288. `--subdir` `<string>` ::
  289. Subdir to mount.
  290. `--tagged_only` `<boolean>` ::
  291. Only use logical volumes tagged with 'pve-vm-ID'.
  292. `--transport` `<rdma | tcp | unix>` ::
  293. Gluster transport: tcp or rdma
  294. `--username` `<string>` ::
  295. RBD Id.
  296. *pvesm status* `[OPTIONS]`
  297. Get status for all datastores.
  298. `--content` `<string>` ::
  299. Only list stores which support this content type.
  300. `--enabled` `<boolean>` ('default =' `0`)::
  301. Only list stores which are enabled (not disabled in config).
  302. `--format` `<boolean>` ('default =' `0`)::
  303. Include information about formats
  304. `--storage` `<string>` ::
  305. Only list status for specified storage
  306. `--target` `<string>` ::
  307. If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
  308. *pvesm zfsscan*
  309. An alias for 'pvesm scan zfs'.