pvesm.1-synopsis.adoc

   1 *pvesm* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *pvesm add* `<type> <storage>` `[OPTIONS]`
   4
   5 Create a new storage.
   6
   7 `<type>` `(dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool)` ::
   8
   9 Storage type.
  10
  11 `<storage>` `string` ::
  12
  13 The storage identifier.
  14
  15 `-authsupported` `string` ::
  16
  17 Authsupported.
  18
  19 `-base` `string` ::
  20
  21 Base volume. This volume is automatically activated.
  22
  23 `-blocksize` `string` ::
  24
  25 block size
  26
  27 `-comstar_hg` `string` ::
  28
  29 host group for comstar views
  30
  31 `-comstar_tg` `string` ::
  32
  33 target group for comstar views
  34
  35 `-content` `string` ::
  36
  37 Allowed content types.
  38 +
  39 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
  40
  41 `-disable` `boolean` ::
  42
  43 Flag to disable the storage.
  44
  45 `-export` `string` ::
  46
  47 NFS export path.
  48
  49 `-format` `string` ::
  50
  51 Default image format.
  52
  53 `-iscsiprovider` `string` ::
  54
  55 iscsi provider
  56
  57 `-krbd` `boolean` ::
  58
  59 Access rbd through krbd kernel module.
  60
  61 `-maxfiles` `integer (0 - N)` ::
  62
  63 Maximal number of backup files per VM. Use '0' for unlimted.
  64
  65 `-monhost` `string` ::
  66
  67 Monitors daemon ips.
  68
  69 `-nodes` `string` ::
  70
  71 List of cluster node names.
  72
  73 `-nowritecache` `boolean` ::
  74
  75 disable write caching on the target
  76
  77 `-options` `string` ::
  78
  79 NFS mount options (see 'man nfs')
  80
  81 `-path` `string` ::
  82
  83 File system path.
  84
  85 `-pool` `string` ::
  86
  87 Pool.
  88
  89 `-portal` `string` ::
  90
  91 iSCSI portal (IP or DNS name with optional port).
  92
  93 `-redundancy` `integer (1 - 16)` (default=`2`)::
  94
  95 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.
  96
  97 `-saferemove` `boolean` ::
  98
  99 Zero-out data when removing LVs.
 100
 101 `-saferemove_throughput` `string` ::
 102
 103 Wipe throughput (cstream -t parameter value).
 104
 105 `-server` `string` ::
 106
 107 Server IP or DNS name.
 108
 109 `-server2` `string` ::
 110
 111 Backup volfile server IP or DNS name.
 112 +
 113 NOTE: Requires option(s): `server`
 114
 115 `-shared` `boolean` ::
 116
 117 Mark storage as shared.
 118
 119 `-sparse` `boolean` ::
 120
 121 use sparse volumes
 122
 123 `-target` `string` ::
 124
 125 iSCSI target.
 126
 127 `-thinpool` `string` ::
 128
 129 LVM thin pool LV name.
 130
 131 `-transport` `(rdma | tcp | unix)` ::
 132
 133 Gluster transport: tcp or rdma
 134
 135 `-username` `string` ::
 136
 137 RBD Id.
 138
 139 `-vgname` `string` ::
 140
 141 Volume group name.
 142
 143 `-volume` `string` ::
 144
 145 Glusterfs Volume.
 146
 147
 148
 149
 150 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
 151
 152 Allocate disk images.
 153
 154 `<storage>` `string` ::
 155
 156 The storage identifier.
 157
 158 `<vmid>` `integer (1 - N)` ::
 159
 160 Specify owner VM
 161
 162 `<filename>` `string` ::
 163
 164 The name of the file to create.
 165
 166 `<size>` `\d+[MG]?` ::
 167
 168 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
 169
 170 `-format` `(qcow2 | raw | subvol)` ::
 171
 172 no description available
 173 +
 174 NOTE: Requires option(s): `size`
 175
 176
 177
 178 *pvesm free* `<volume>` `[OPTIONS]`
 179
 180 Delete volume
 181
 182 `<volume>` `string` ::
 183
 184 Volume identifier
 185
 186 `-storage` `string` ::
 187
 188 The storage identifier.
 189
 190
 191
 192
 193 *pvesm glusterfsscan* `<server>`
 194
 195 Scan remote GlusterFS server.
 196
 197 `<server>` `string` ::
 198
 199 no description available
 200
 201
 202
 203
 204 *pvesm help* `[<cmd>]` `[OPTIONS]`
 205
 206 Get help about specified command.
 207
 208 `<cmd>` `string` ::
 209
 210 Command name
 211
 212 `-verbose` `boolean` ::
 213
 214 Verbose output format.
 215
 216
 217
 218
 219 *pvesm iscsiscan* `-portal <string>` `[OPTIONS]`
 220
 221 Scan remote iSCSI server.
 222
 223 `-portal` `string` ::
 224
 225 no description available
 226
 227
 228
 229
 230 *pvesm list* `<storage>` `[OPTIONS]`
 231
 232 List storage content.
 233
 234 `<storage>` `string` ::
 235
 236 The storage identifier.
 237
 238 `-content` `string` ::
 239
 240 Only list content of this type.
 241
 242 `-vmid` `integer (1 - N)` ::
 243
 244 Only list images for this VM
 245
 246
 247
 248
 249 *pvesm lvmscan*
 250
 251 List local LVM volume groups.
 252
 253
 254
 255 *pvesm lvmthinscan* `<vg>`
 256
 257 List local LVM Thin Pools.
 258
 259 `<vg>` `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
 260
 261 no description available
 262
 263
 264
 265 *pvesm nfsscan* `<server>`
 266
 267 Scan remote NFS server.
 268
 269 `<server>` `string` ::
 270
 271 no description available
 272
 273
 274
 275
 276 *pvesm path* `<volume>`
 277
 278 Get filesystem path for specified volume
 279
 280 `<volume>` `string` ::
 281
 282 Volume identifier
 283
 284
 285
 286
 287 *pvesm remove* `<storage>`
 288
 289 Delete storage configuration.
 290
 291 `<storage>` `string` ::
 292
 293 The storage identifier.
 294
 295
 296
 297 *pvesm set* `<storage>` `[OPTIONS]`
 298
 299 Update storage configuration.
 300
 301 `<storage>` `string` ::
 302
 303 The storage identifier.
 304
 305 `-blocksize` `string` ::
 306
 307 block size
 308
 309 `-comstar_hg` `string` ::
 310
 311 host group for comstar views
 312
 313 `-comstar_tg` `string` ::
 314
 315 target group for comstar views
 316
 317 `-content` `string` ::
 318
 319 Allowed content types.
 320 +
 321 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 322
 323 `-delete` `string` ::
 324
 325 A list of settings you want to delete.
 326
 327 `-digest` `string` ::
 328
 329 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 330
 331 `-disable` `boolean` ::
 332
 333 Flag to disable the storage.
 334
 335 `-format` `string` ::
 336
 337 Default image format.
 338
 339 `-krbd` `boolean` ::
 340
 341 Access rbd through krbd kernel module.
 342
 343 `-maxfiles` `integer (0 - N)` ::
 344
 345 Maximal number of backup files per VM. Use '0' for unlimted.
 346
 347 `-nodes` `string` ::
 348
 349 List of cluster node names.
 350
 351 `-nowritecache` `boolean` ::
 352
 353 disable write caching on the target
 354
 355 `-options` `string` ::
 356
 357 NFS mount options (see 'man nfs')
 358
 359 `-pool` `string` ::
 360
 361 Pool.
 362
 363 `-redundancy` `integer (1 - 16)` (default=`2`)::
 364
 365 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.
 366
 367 `-saferemove` `boolean` ::
 368
 369 Zero-out data when removing LVs.
 370
 371 `-saferemove_throughput` `string` ::
 372
 373 Wipe throughput (cstream -t parameter value).
 374
 375 `-server` `string` ::
 376
 377 Server IP or DNS name.
 378
 379 `-server2` `string` ::
 380
 381 Backup volfile server IP or DNS name.
 382 +
 383 NOTE: Requires option(s): `server`
 384
 385 `-shared` `boolean` ::
 386
 387 Mark storage as shared.
 388
 389 `-sparse` `boolean` ::
 390
 391 use sparse volumes
 392
 393 `-transport` `(rdma | tcp | unix)` ::
 394
 395 Gluster transport: tcp or rdma
 396
 397 `-username` `string` ::
 398
 399 RBD Id.
 400
 401
 402
 403
 404 *pvesm status* `[OPTIONS]`
 405
 406 Get status for all datastores.
 407
 408 `-content` `string` ::
 409
 410 Only list stores which support this content type.
 411
 412 `-enabled` `boolean` (default=`0`)::
 413
 414 Only list stores which are enabled (not disabled in config).
 415
 416 `-storage` `string` ::
 417
 418 Only list status for  specified storage
 419
 420 `-target` `string` ::
 421
 422 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
 423
 424
 425
 426
 427 *pvesm zfsscan*
 428
 429 Scan zfs pool list on local node.
 430
 431
 432
 433