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