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