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>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | 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 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
  28
  29 Set bandwidth/io limits various operations.
  30
  31 `--comstar_hg` `<string>` ::
  32
  33 host group for comstar views
  34
  35 `--comstar_tg` `<string>` ::
  36
  37 target group for comstar views
  38
  39 `--content` `<string>` ::
  40
  41 Allowed content types.
  42 +
  43 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
  44
  45 `--datastore` `<string>` ::
  46
  47 Proxmox backup server datastore name.
  48
  49 `--disable` `<boolean>` ::
  50
  51 Flag to disable the storage.
  52
  53 `--domain` `<string>` ::
  54
  55 CIFS domain.
  56
  57 `--export` `<string>` ::
  58
  59 NFS export path.
  60
  61 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
  62
  63 Certificate SHA 256 fingerprint.
  64
  65 `--format` `<string>` ::
  66
  67 Default image format.
  68
  69 `--fuse` `<boolean>` ::
  70
  71 Mount CephFS through FUSE.
  72
  73 `--is_mountpoint` `<string>` ('default =' `no`)::
  74
  75 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.
  76
  77 `--iscsiprovider` `<string>` ::
  78
  79 iscsi provider
  80
  81 `--krbd` `<boolean>` ::
  82
  83 Always access rbd through krbd kernel module.
  84
  85 `--lio_tpg` `<string>` ::
  86
  87 target portal group for Linux LIO targets
  88
  89 `--maxfiles` `<integer> (0 - N)` ::
  90
  91 Maximal number of backup files per VM. Use '0' for unlimted.
  92
  93 `--mkdir` `<boolean>` ('default =' `yes`)::
  94
  95 Create the directory if it doesn't exist.
  96
  97 `--monhost` `<string>` ::
  98
  99 IP addresses of monitors (for external clusters).
 100
 101 `--mountpoint` `<string>` ::
 102
 103 mount point
 104
 105 `--nodes` `<string>` ::
 106
 107 List of cluster node names.
 108
 109 `--nowritecache` `<boolean>` ::
 110
 111 disable write caching on the target
 112
 113 `--options` `<string>` ::
 114
 115 NFS mount options (see 'man nfs')
 116
 117 `--password` `<password>` ::
 118
 119 Password for CIFS share.
 120
 121 `--path` `<string>` ::
 122
 123 File system path.
 124
 125 `--pool` `<string>` ::
 126
 127 Pool.
 128
 129 `--portal` `<string>` ::
 130
 131 iSCSI portal (IP or DNS name with optional port).
 132
 133 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
 134
 135 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.
 136
 137 `--saferemove` `<boolean>` ::
 138
 139 Zero-out data when removing LVs.
 140
 141 `--saferemove_throughput` `<string>` ::
 142
 143 Wipe throughput (cstream -t parameter value).
 144
 145 `--server` `<string>` ::
 146
 147 Server IP or DNS name.
 148
 149 `--server2` `<string>` ::
 150
 151 Backup volfile server IP or DNS name.
 152 +
 153 NOTE: Requires option(s): `server`
 154
 155 `--share` `<string>` ::
 156
 157 CIFS share.
 158
 159 `--shared` `<boolean>` ::
 160
 161 Mark storage as shared.
 162
 163 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
 164
 165 SMB protocol version
 166
 167 `--sparse` `<boolean>` ::
 168
 169 use sparse volumes
 170
 171 `--subdir` `<string>` ::
 172
 173 Subdir to mount.
 174
 175 `--tagged_only` `<boolean>` ::
 176
 177 Only use logical volumes tagged with 'pve-vm-ID'.
 178
 179 `--target` `<string>` ::
 180
 181 iSCSI target.
 182
 183 `--thinpool` `<string>` ::
 184
 185 LVM thin pool LV name.
 186
 187 `--transport` `<rdma | tcp | unix>` ::
 188
 189 Gluster transport: tcp or rdma
 190
 191 `--username` `<string>` ::
 192
 193 RBD Id.
 194
 195 `--vgname` `<string>` ::
 196
 197 Volume group name.
 198
 199 `--volume` `<string>` ::
 200
 201 Glusterfs Volume.
 202
 203 *pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
 204
 205 Allocate disk images.
 206
 207 `<storage>`: `<string>` ::
 208
 209 The storage identifier.
 210
 211 `<vmid>`: `<integer> (1 - N)` ::
 212
 213 Specify owner VM
 214
 215 `<filename>`: `<string>` ::
 216
 217 The name of the file to create.
 218
 219 `<size>`: `\d+[MG]?` ::
 220
 221 Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
 222
 223 `--format` `<qcow2 | raw | subvol>` ::
 224
 225 no description available
 226 +
 227 NOTE: Requires option(s): `size`
 228
 229 *pvesm apiinfo*
 230
 231 Returns APIVER and APIAGE.
 232
 233 *pvesm cifsscan*
 234
 235 An alias for 'pvesm scan cifs'.
 236
 237 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
 238
 239 Export a volume.
 240
 241 `<volume>`: `<string>` ::
 242
 243 Volume identifier
 244
 245 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
 246
 247 Export stream format
 248
 249 `<filename>`: `<string>` ::
 250
 251 Destination file name
 252
 253 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
 254
 255 Snapshot to start an incremental stream from
 256
 257 `--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
 258
 259 Snapshot to export
 260
 261 `--with-snapshots` `<boolean>` ('default =' `0`)::
 262
 263 Whether to include intermediate snapshots in the stream
 264
 265 *pvesm extractconfig* `<volume>`
 266
 267 Extract configuration from vzdump backup archive.
 268
 269 `<volume>`: `<string>` ::
 270
 271 Volume identifier
 272
 273 *pvesm free* `<volume>` `[OPTIONS]`
 274
 275 Delete volume
 276
 277 `<volume>`: `<string>` ::
 278
 279 Volume identifier
 280
 281 `--delay` `<integer> (1 - 30)` ::
 282
 283 Time to wait for the task to finish. We return 'null' if the task finish within that time.
 284
 285 `--storage` `<string>` ::
 286
 287 The storage identifier.
 288
 289 *pvesm glusterfsscan*
 290
 291 An alias for 'pvesm scan glusterfs'.
 292
 293 *pvesm help* `[OPTIONS]`
 294
 295 Get help about specified command.
 296
 297 `--extra-args` `<array>` ::
 298
 299 Shows help for a specific command
 300
 301 `--verbose` `<boolean>` ::
 302
 303 Verbose output format.
 304
 305 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
 306
 307 Import a volume.
 308
 309 `<volume>`: `<string>` ::
 310
 311 Volume identifier
 312
 313 `<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
 314
 315 Import stream format
 316
 317 `<filename>`: `<string>` ::
 318
 319 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.
 320
 321 `--allow-rename` `<boolean>` ('default =' `0`)::
 322
 323 Choose a new volume ID if the requested volume ID already exists, instead of throwing an error.
 324
 325 `--base` `(?^:[a-z0-9_\-]{1,40})` ::
 326
 327 Base snapshot of an incremental stream
 328
 329 `--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
 330
 331 A snapshot to delete on success
 332
 333 `--with-snapshots` `<boolean>` ('default =' `0`)::
 334
 335 Whether the stream includes intermediate snapshots
 336
 337 *pvesm iscsiscan*
 338
 339 An alias for 'pvesm scan iscsi'.
 340
 341 *pvesm list* `<storage>` `[OPTIONS]`
 342
 343 List storage content.
 344
 345 `<storage>`: `<string>` ::
 346
 347 The storage identifier.
 348
 349 `--content` `<string>` ::
 350
 351 Only list content of this type.
 352
 353 `--vmid` `<integer> (1 - N)` ::
 354
 355 Only list images for this VM
 356
 357 *pvesm lvmscan*
 358
 359 An alias for 'pvesm scan lvm'.
 360
 361 *pvesm lvmthinscan*
 362
 363 An alias for 'pvesm scan lvmthin'.
 364
 365 *pvesm nfsscan*
 366
 367 An alias for 'pvesm scan nfs'.
 368
 369 *pvesm path* `<volume>`
 370
 371 Get filesystem path for specified volume
 372
 373 `<volume>`: `<string>` ::
 374
 375 Volume identifier
 376
 377 *pvesm remove* `<storage>`
 378
 379 Delete storage configuration.
 380
 381 `<storage>`: `<string>` ::
 382
 383 The storage identifier.
 384
 385 *pvesm scan cifs* `<server>` `[OPTIONS]`
 386
 387 Scan remote CIFS server.
 388
 389 `<server>`: `<string>` ::
 390
 391 The server address (name or IP).
 392
 393 `--domain` `<string>` ::
 394
 395 SMB domain (Workgroup).
 396
 397 `--password` `<password>` ::
 398
 399 User password.
 400
 401 `--username` `<string>` ::
 402
 403 User name.
 404
 405 *pvesm scan glusterfs* `<server>`
 406
 407 Scan remote GlusterFS server.
 408
 409 `<server>`: `<string>` ::
 410
 411 The server address (name or IP).
 412
 413 *pvesm scan iscsi* `<portal>`
 414
 415 Scan remote iSCSI server.
 416
 417 `<portal>`: `<string>` ::
 418
 419 The iSCSI portal (IP or DNS name with optional port).
 420
 421 *pvesm scan lvm*
 422
 423 List local LVM volume groups.
 424
 425 *pvesm scan lvmthin* `<vg>`
 426
 427 List local LVM Thin Pools.
 428
 429 `<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
 430
 431 no description available
 432
 433 *pvesm scan nfs* `<server>`
 434
 435 Scan remote NFS server.
 436
 437 `<server>`: `<string>` ::
 438
 439 The server address (name or IP).
 440
 441 *pvesm scan zfs*
 442
 443 Scan zfs pool list on local node.
 444
 445 *pvesm set* `<storage>` `[OPTIONS]`
 446
 447 Update storage configuration.
 448
 449 `<storage>`: `<string>` ::
 450
 451 The storage identifier.
 452
 453 `--blocksize` `<string>` ::
 454
 455 block size
 456
 457 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
 458
 459 Set bandwidth/io limits various operations.
 460
 461 `--comstar_hg` `<string>` ::
 462
 463 host group for comstar views
 464
 465 `--comstar_tg` `<string>` ::
 466
 467 target group for comstar views
 468
 469 `--content` `<string>` ::
 470
 471 Allowed content types.
 472 +
 473 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 474
 475 `--delete` `<string>` ::
 476
 477 A list of settings you want to delete.
 478
 479 `--digest` `<string>` ::
 480
 481 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 482
 483 `--disable` `<boolean>` ::
 484
 485 Flag to disable the storage.
 486
 487 `--domain` `<string>` ::
 488
 489 CIFS domain.
 490
 491 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
 492
 493 Certificate SHA 256 fingerprint.
 494
 495 `--format` `<string>` ::
 496
 497 Default image format.
 498
 499 `--fuse` `<boolean>` ::
 500
 501 Mount CephFS through FUSE.
 502
 503 `--is_mountpoint` `<string>` ('default =' `no`)::
 504
 505 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.
 506
 507 `--krbd` `<boolean>` ::
 508
 509 Always access rbd through krbd kernel module.
 510
 511 `--lio_tpg` `<string>` ::
 512
 513 target portal group for Linux LIO targets
 514
 515 `--maxfiles` `<integer> (0 - N)` ::
 516
 517 Maximal number of backup files per VM. Use '0' for unlimted.
 518
 519 `--mkdir` `<boolean>` ('default =' `yes`)::
 520
 521 Create the directory if it doesn't exist.
 522
 523 `--monhost` `<string>` ::
 524
 525 IP addresses of monitors (for external clusters).
 526
 527 `--mountpoint` `<string>` ::
 528
 529 mount point
 530
 531 `--nodes` `<string>` ::
 532
 533 List of cluster node names.
 534
 535 `--nowritecache` `<boolean>` ::
 536
 537 disable write caching on the target
 538
 539 `--options` `<string>` ::
 540
 541 NFS mount options (see 'man nfs')
 542
 543 `--password` `<string>` ::
 544
 545 Password for CIFS share.
 546
 547 `--pool` `<string>` ::
 548
 549 Pool.
 550
 551 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
 552
 553 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.
 554
 555 `--saferemove` `<boolean>` ::
 556
 557 Zero-out data when removing LVs.
 558
 559 `--saferemove_throughput` `<string>` ::
 560
 561 Wipe throughput (cstream -t parameter value).
 562
 563 `--server` `<string>` ::
 564
 565 Server IP or DNS name.
 566
 567 `--server2` `<string>` ::
 568
 569 Backup volfile server IP or DNS name.
 570 +
 571 NOTE: Requires option(s): `server`
 572
 573 `--shared` `<boolean>` ::
 574
 575 Mark storage as shared.
 576
 577 `--smbversion` `<2.0 | 2.1 | 3.0>` ::
 578
 579 SMB protocol version
 580
 581 `--sparse` `<boolean>` ::
 582
 583 use sparse volumes
 584
 585 `--subdir` `<string>` ::
 586
 587 Subdir to mount.
 588
 589 `--tagged_only` `<boolean>` ::
 590
 591 Only use logical volumes tagged with 'pve-vm-ID'.
 592
 593 `--transport` `<rdma | tcp | unix>` ::
 594
 595 Gluster transport: tcp or rdma
 596
 597 `--username` `<string>` ::
 598
 599 RBD Id.
 600
 601 *pvesm status* `[OPTIONS]`
 602
 603 Get status for all datastores.
 604
 605 `--content` `<string>` ::
 606
 607 Only list stores which support this content type.
 608
 609 `--enabled` `<boolean>` ('default =' `0`)::
 610
 611 Only list stores which are enabled (not disabled in config).
 612
 613 `--format` `<boolean>` ('default =' `0`)::
 614
 615 Include information about formats
 616
 617 `--storage` `<string>` ::
 618
 619 Only list status for  specified storage
 620
 621 `--target` `<string>` ::
 622
 623 If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
 624
 625 *pvesm zfsscan*
 626
 627 An alias for 'pvesm scan zfs'.
 628
 629