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