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.

pvesm.1-synopsis.adoc 10KB

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