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