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