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