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 `--is_mountpoint` `<string>` ('default =' `no`)::
  54
  55 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.
  56
  57 `--iscsiprovider` `<string>` ::
  58
  59 iscsi provider
  60
  61 `--krbd` `<boolean>` ::
  62
  63 Access rbd through krbd kernel module.
  64
  65 `--maxfiles` `<integer> (0 - N)` ::
  66
  67 Maximal number of backup files per VM. Use '0' for unlimted.
  68
  69 `--mkdir` `<boolean>` ('default =' `yes`)::
  70
  71 Create the directory if it doesn't exist.
  72
  73 `--monhost` `<string>` ::
  74
  75 IP addresses of monitors (for external clusters).
  76
  77 `--nodes` `<string>` ::
  78
  79 List of cluster node names.
  80
  81 `--nowritecache` `<boolean>` ::
  82
  83 disable write caching on the target
  84
  85 `--options` `<string>` ::
  86
  87 NFS mount options (see 'man nfs')
  88
  89 `--path` `<string>` ::
  90
  91 File system path.
  92
  93 `--pool` `<string>` ::
  94
  95 Pool.
  96
  97 `--portal` `<string>` ::
  98
  99 iSCSI portal (IP or DNS name with optional port).
 100
 101 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
 102
 103 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.
 104
 105 `--saferemove` `<boolean>` ::
 106
 107 Zero-out data when removing LVs.
 108
 109 `--saferemove_throughput` `<string>` ::
 110
 111 Wipe throughput (cstream -t parameter value).
 112
 113 `--server` `<string>` ::
 114
 115 Server IP or DNS name.
 116
 117 `--server2` `<string>` ::
 118
 119 Backup volfile server IP or DNS name.
 120 +
 121 NOTE: Requires option(s): `server`
 122
 123 `--shared` `<boolean>` ::
 124
 125 Mark storage as shared.
 126
 127 `--sparse` `<boolean>` ::
 128
 129 use sparse volumes
 130
 131 `--tagged_only` `<boolean>` ::
 132
 133 Only use logical volumes tagged with 'pve-vm-ID'.
 134
 135 `--target` `<string>` ::
 136
 137 iSCSI target.
 138
 139 `--thinpool` `<string>` ::
 140
 141 LVM thin pool LV name.
 142
 143 `--transport` `<rdma | tcp | unix>` ::
 144
 145 Gluster transport: tcp or rdma
 146
 147 `--username` `<string>` ::
 148
 149 RBD Id.
 150
 151 `--vgname` `<string>` ::
 152
 153 Volume group name.
 154
 155 `--volume` `<string>` ::
 156
 157 Glusterfs Volume.
 158
 159 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
 160
 161 Allocate disk images.
 162
 163 `<storage>`: `<string>` ::
 164
 165 The storage identifier.
 166
 167 `<vmid>`: `<integer> (1 - N)` ::
 168
 169 Specify owner VM
 170
 171 `<filename>`: `<string>` ::
 172
 173 The name of the file to create.
 174
 175 `<size>`: `\d+[MG]?` ::
 176
 177 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
 178
 179 `--format` `<qcow2 | raw | subvol>` ::
 180
 181 no description available
 182 +
 183 NOTE: Requires option(s): `size`
 184
 185 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
 186
 187 Export a volume.
 188
 189 `<volume>`: `<string>` ::
 190
 191 Volume identifier
 192
 193 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
 194
 195 Export stream format
 196
 197 `<filename>`: `<string>` ::
 198
 199 Destination file name
 200
 201 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
 202
 203 Snapshot to start an incremental stream from
 204
 205 `--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
 206
 207 Snapshot to export
 208
 209 `--with-snapshots` `<boolean>` ('default =' `0`)::
 210
 211 Whether to include intermediate snapshots in the stream
 212
 213 *pvesm extractconfig* `<volume>`
 214
 215 Extract configuration from vzdump backup archive.
 216
 217 `<volume>`: `<string>` ::
 218
 219 Volume identifier
 220
 221 *pvesm free* `<volume>` `[OPTIONS]`
 222
 223 Delete volume
 224
 225 `<volume>`: `<string>` ::
 226
 227 Volume identifier
 228
 229 `--storage` `<string>` ::
 230
 231 The storage identifier.
 232
 233 *pvesm glusterfsscan* `<server>`
 234
 235 Scan remote GlusterFS server.
 236
 237 `<server>`: `<string>` ::
 238
 239 no description available
 240
 241 *pvesm help* `[OPTIONS]`
 242
 243 Get help about specified command.
 244
 245 `--extra-args` `<array>` ::
 246
 247 Shows help for a specific command
 248
 249 `--verbose` `<boolean>` ::
 250
 251 Verbose output format.
 252
 253 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
 254
 255 Import a volume.
 256
 257 `<volume>`: `<string>` ::
 258
 259 Volume identifier
 260
 261 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
 262
 263 Import stream format
 264
 265 `<filename>`: `<string>` ::
 266
 267 Source file name
 268
 269 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
 270
 271 Base snapshot of an incremental stream
 272
 273 `--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
 274
 275 A snapshot to delete on success
 276
 277 `--with-snapshots` `<boolean>` ('default =' `0`)::
 278
 279 Whether the stream includes intermediate snapshots
 280
 281 *pvesm iscsiscan* `--portal <string>` `[OPTIONS]`
 282
 283 Scan remote iSCSI server.
 284
 285 `--portal` `<string>` ::
 286
 287 no description available
 288
 289 *pvesm list* `<storage>` `[OPTIONS]`
 290
 291 List storage content.
 292
 293 `<storage>`: `<string>` ::
 294
 295 The storage identifier.
 296
 297 `--content` `<string>` ::
 298
 299 Only list content of this type.
 300
 301 `--vmid` `<integer> (1 - N)` ::
 302
 303 Only list images for this VM
 304
 305 *pvesm lvmscan*
 306
 307 List local LVM volume groups.
 308
 309 *pvesm lvmthinscan* `<vg>`
 310
 311 List local LVM Thin Pools.
 312
 313 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
 314
 315 no description available
 316
 317 *pvesm nfsscan* `<server>`
 318
 319 Scan remote NFS server.
 320
 321 `<server>`: `<string>` ::
 322
 323 no description available
 324
 325 *pvesm path* `<volume>`
 326
 327 Get filesystem path for specified volume
 328
 329 `<volume>`: `<string>` ::
 330
 331 Volume identifier
 332
 333 *pvesm remove* `<storage>`
 334
 335 Delete storage configuration.
 336
 337 `<storage>`: `<string>` ::
 338
 339 The storage identifier.
 340
 341 *pvesm set* `<storage>` `[OPTIONS]`
 342
 343 Update storage configuration.
 344
 345 `<storage>`: `<string>` ::
 346
 347 The storage identifier.
 348
 349 `--blocksize` `<string>` ::
 350
 351 block size
 352
 353 `--comstar_hg` `<string>` ::
 354
 355 host group for comstar views
 356
 357 `--comstar_tg` `<string>` ::
 358
 359 target group for comstar views
 360
 361 `--content` `<string>` ::
 362
 363 Allowed content types.
 364 +
 365 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 366
 367 `--delete` `<string>` ::
 368
 369 A list of settings you want to delete.
 370
 371 `--digest` `<string>` ::
 372
 373 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 374
 375 `--disable` `<boolean>` ::
 376
 377 Flag to disable the storage.
 378
 379 `--format` `<string>` ::
 380
 381 Default image format.
 382
 383 `--is_mountpoint` `<string>` ('default =' `no`)::
 384
 385 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.
 386
 387 `--krbd` `<boolean>` ::
 388
 389 Access rbd through krbd kernel module.
 390
 391 `--maxfiles` `<integer> (0 - N)` ::
 392
 393 Maximal number of backup files per VM. Use '0' for unlimted.
 394
 395 `--mkdir` `<boolean>` ('default =' `yes`)::
 396
 397 Create the directory if it doesn't exist.
 398
 399 `--monhost` `<string>` ::
 400
 401 IP addresses of monitors (for external clusters).
 402
 403 `--nodes` `<string>` ::
 404
 405 List of cluster node names.
 406
 407 `--nowritecache` `<boolean>` ::
 408
 409 disable write caching on the target
 410
 411 `--options` `<string>` ::
 412
 413 NFS mount options (see 'man nfs')
 414
 415 `--pool` `<string>` ::
 416
 417 Pool.
 418
 419 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
 420
 421 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.
 422
 423 `--saferemove` `<boolean>` ::
 424
 425 Zero-out data when removing LVs.
 426
 427 `--saferemove_throughput` `<string>` ::
 428
 429 Wipe throughput (cstream -t parameter value).
 430
 431 `--server` `<string>` ::
 432
 433 Server IP or DNS name.
 434
 435 `--server2` `<string>` ::
 436
 437 Backup volfile server IP or DNS name.
 438 +
 439 NOTE: Requires option(s): `server`
 440
 441 `--shared` `<boolean>` ::
 442
 443 Mark storage as shared.
 444
 445 `--sparse` `<boolean>` ::
 446
 447 use sparse volumes
 448
 449 `--tagged_only` `<boolean>` ::
 450
 451 Only use logical volumes tagged with 'pve-vm-ID'.
 452
 453 `--transport` `<rdma | tcp | unix>` ::
 454
 455 Gluster transport: tcp or rdma
 456
 457 `--username` `<string>` ::
 458
 459 RBD Id.
 460
 461 *pvesm status* `[OPTIONS]`
 462
 463 Get status for all datastores.
 464
 465 `--content` `<string>` ::
 466
 467 Only list stores which support this content type.
 468
 469 `--enabled` `<boolean>` ('default =' `0`)::
 470
 471 Only list stores which are enabled (not disabled in config).
 472
 473 `--format` `<boolean>` ('default =' `0`)::
 474
 475 Include information about formats
 476
 477 `--storage` `<string>` ::
 478
 479 Only list status for  specified storage
 480
 481 `--target` `<string>` ::
 482
 483 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
 484
 485 *pvesm zfsscan*
 486
 487 Scan zfs pool list on local node.
 488
 489