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