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