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