pveum.1-synopsis.adoc

   1 *pveum* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *pveum acl delete* `<path> --roles <string>` `[OPTIONS]`
   4
   5 Update Access Control List (add or remove permissions).
   6
   7 `<path>`: `<string>` ::
   8
   9 Access control path
  10
  11 `--groups` `<string>` ::
  12
  13 List of groups.
  14
  15 `--propagate` `<boolean>` ('default =' `1`)::
  16
  17 Allow to propagate (inherit) permissions.
  18
  19 `--roles` `<string>` ::
  20
  21 List of roles.
  22
  23 `--tokens` `<string>` ::
  24
  25 List of API tokens.
  26
  27 `--users` `<string>` ::
  28
  29 List of users.
  30
  31 *pveum acl list* `[FORMAT_OPTIONS]`
  32
  33 Get Access Control List (ACLs).
  34
  35 *pveum acl modify* `<path> --roles <string>` `[OPTIONS]`
  36
  37 Update Access Control List (add or remove permissions).
  38
  39 `<path>`: `<string>` ::
  40
  41 Access control path
  42
  43 `--groups` `<string>` ::
  44
  45 List of groups.
  46
  47 `--propagate` `<boolean>` ('default =' `1`)::
  48
  49 Allow to propagate (inherit) permissions.
  50
  51 `--roles` `<string>` ::
  52
  53 List of roles.
  54
  55 `--tokens` `<string>` ::
  56
  57 List of API tokens.
  58
  59 `--users` `<string>` ::
  60
  61 List of users.
  62
  63 *pveum acldel*
  64
  65 An alias for 'pveum acl delete'.
  66
  67 *pveum aclmod*
  68
  69 An alias for 'pveum acl modify'.
  70
  71 *pveum group add* `<groupid>` `[OPTIONS]`
  72
  73 Create new group.
  74
  75 `<groupid>`: `<string>` ::
  76
  77 no description available
  78
  79 `--comment` `<string>` ::
  80
  81 no description available
  82
  83 *pveum group delete* `<groupid>`
  84
  85 Delete group.
  86
  87 `<groupid>`: `<string>` ::
  88
  89 no description available
  90
  91 *pveum group list* `[FORMAT_OPTIONS]`
  92
  93 Group index.
  94
  95 *pveum group modify* `<groupid>` `[OPTIONS]`
  96
  97 Update group data.
  98
  99 `<groupid>`: `<string>` ::
 100
 101 no description available
 102
 103 `--comment` `<string>` ::
 104
 105 no description available
 106
 107 *pveum groupadd*
 108
 109 An alias for 'pveum group add'.
 110
 111 *pveum groupdel*
 112
 113 An alias for 'pveum group delete'.
 114
 115 *pveum groupmod*
 116
 117 An alias for 'pveum group modify'.
 118
 119 *pveum help* `[OPTIONS]`
 120
 121 Get help about specified command.
 122
 123 `--extra-args` `<array>` ::
 124
 125 Shows help for a specific command
 126
 127 `--verbose` `<boolean>` ::
 128
 129 Verbose output format.
 130
 131 *pveum passwd* `<userid>`
 132
 133 Change user password.
 134
 135 `<userid>`: `<string>` ::
 136
 137 User ID
 138
 139 *pveum pool add* `<poolid>` `[OPTIONS]`
 140
 141 Create new pool.
 142
 143 `<poolid>`: `<string>` ::
 144
 145 no description available
 146
 147 `--comment` `<string>` ::
 148
 149 no description available
 150
 151 *pveum pool delete* `<poolid>`
 152
 153 Delete pool.
 154
 155 `<poolid>`: `<string>` ::
 156
 157 no description available
 158
 159 *pveum pool list* `[FORMAT_OPTIONS]`
 160
 161 Pool index.
 162
 163 *pveum pool modify* `<poolid>` `[OPTIONS]`
 164
 165 Update pool data.
 166
 167 `<poolid>`: `<string>` ::
 168
 169 no description available
 170
 171 `--comment` `<string>` ::
 172
 173 no description available
 174
 175 `--delete` `<boolean>` ::
 176
 177 Remove vms/storage (instead of adding it).
 178
 179 `--storage` `<string>` ::
 180
 181 List of storage IDs.
 182
 183 `--vms` `<string>` ::
 184
 185 List of virtual machines.
 186
 187 *pveum realm add* `<realm> --type <string>` `[OPTIONS]`
 188
 189 Add an authentication server.
 190
 191 `<realm>`: `<string>` ::
 192
 193 Authentication domain ID
 194
 195 `--autocreate` `<boolean>` ('default =' `0`)::
 196
 197 Automatically create users if they do not exist.
 198
 199 `--base_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 200
 201 LDAP base domain name
 202
 203 `--bind_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 204
 205 LDAP bind domain name
 206
 207 `--capath` `<string>` ('default =' `/etc/ssl/certs`)::
 208
 209 Path to the CA certificate store
 210
 211 `--case-sensitive` `<boolean>` ('default =' `1`)::
 212
 213 username is case-sensitive
 214
 215 `--cert` `<string>` ::
 216
 217 Path to the client certificate
 218
 219 `--certkey` `<string>` ::
 220
 221 Path to the client certificate key
 222
 223 `--client-id` `<string>` ::
 224
 225 OpenID Client ID
 226
 227 `--client-key` `<string>` ::
 228
 229 OpenID Client Key
 230
 231 `--comment` `<string>` ::
 232
 233 Description.
 234
 235 `--default` `<boolean>` ::
 236
 237 Use this as default realm
 238
 239 `--domain` `\S+` ::
 240
 241 AD domain name
 242
 243 `--filter` `<string>` ::
 244
 245 LDAP filter for user sync.
 246
 247 `--group_classes` `<string>` ('default =' `groupOfNames, group, univentionGroup, ipausergroup`)::
 248
 249 The objectclasses for groups.
 250
 251 `--group_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 252
 253 LDAP base domain name for group sync. If not set, the base_dn will be used.
 254
 255 `--group_filter` `<string>` ::
 256
 257 LDAP filter for group sync.
 258
 259 `--group_name_attr` `<string>` ::
 260
 261 LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.
 262
 263 `--issuer-url` `<string>` ::
 264
 265 OpenID Issuer Url
 266
 267 `--mode` `<ldap | ldap+starttls | ldaps>` ('default =' `ldap`)::
 268
 269 LDAP protocol mode.
 270
 271 `--password` `<string>` ::
 272
 273 LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.
 274
 275 `--port` `<integer> (1 - 65535)` ::
 276
 277 Server port.
 278
 279 `--secure` `<boolean>` ::
 280
 281 Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.
 282
 283 `--server1` `<string>` ::
 284
 285 Server IP address (or DNS name)
 286
 287 `--server2` `<string>` ::
 288
 289 Fallback Server IP address (or DNS name)
 290
 291 `--sslversion` `<tlsv1 | tlsv1_1 | tlsv1_2 | tlsv1_3>` ::
 292
 293 LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!
 294
 295 `--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,scope=<users|groups|both>]` ::
 296
 297 The default options for behavior of synchronizations.
 298
 299 `--sync_attributes` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 300
 301 Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write  'email=mail'. By default, each PVE user field is represented  by an LDAP attribute of the same name.
 302
 303 `--tfa` `type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]` ::
 304
 305 Use Two-factor authentication.
 306
 307 `--type` `<ad | ldap | openid | pam | pve>` ::
 308
 309 Realm type.
 310
 311 `--user_attr` `\S{2,}` ::
 312
 313 LDAP user attribute name
 314
 315 `--user_classes` `<string>` ('default =' `inetorgperson, posixaccount, person, user`)::
 316
 317 The objectclasses for users.
 318
 319 `--username-claim` `<email | subject | username>` ::
 320
 321 OpenID claim used to generate the unique username.
 322
 323 `--verify` `<boolean>` ('default =' `0`)::
 324
 325 Verify the server's SSL certificate
 326
 327 *pveum realm delete* `<realm>`
 328
 329 Delete an authentication server.
 330
 331 `<realm>`: `<string>` ::
 332
 333 Authentication domain ID
 334
 335 *pveum realm list* `[FORMAT_OPTIONS]`
 336
 337 Authentication domain index.
 338
 339 *pveum realm modify* `<realm>` `[OPTIONS]`
 340
 341 Update authentication server settings.
 342
 343 `<realm>`: `<string>` ::
 344
 345 Authentication domain ID
 346
 347 `--autocreate` `<boolean>` ('default =' `0`)::
 348
 349 Automatically create users if they do not exist.
 350
 351 `--base_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 352
 353 LDAP base domain name
 354
 355 `--bind_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 356
 357 LDAP bind domain name
 358
 359 `--capath` `<string>` ('default =' `/etc/ssl/certs`)::
 360
 361 Path to the CA certificate store
 362
 363 `--case-sensitive` `<boolean>` ('default =' `1`)::
 364
 365 username is case-sensitive
 366
 367 `--cert` `<string>` ::
 368
 369 Path to the client certificate
 370
 371 `--certkey` `<string>` ::
 372
 373 Path to the client certificate key
 374
 375 `--client-id` `<string>` ::
 376
 377 OpenID Client ID
 378
 379 `--client-key` `<string>` ::
 380
 381 OpenID Client Key
 382
 383 `--comment` `<string>` ::
 384
 385 Description.
 386
 387 `--default` `<boolean>` ::
 388
 389 Use this as default realm
 390
 391 `--delete` `<string>` ::
 392
 393 A list of settings you want to delete.
 394
 395 `--digest` `<string>` ::
 396
 397 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 398
 399 `--domain` `\S+` ::
 400
 401 AD domain name
 402
 403 `--filter` `<string>` ::
 404
 405 LDAP filter for user sync.
 406
 407 `--group_classes` `<string>` ('default =' `groupOfNames, group, univentionGroup, ipausergroup`)::
 408
 409 The objectclasses for groups.
 410
 411 `--group_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 412
 413 LDAP base domain name for group sync. If not set, the base_dn will be used.
 414
 415 `--group_filter` `<string>` ::
 416
 417 LDAP filter for group sync.
 418
 419 `--group_name_attr` `<string>` ::
 420
 421 LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.
 422
 423 `--issuer-url` `<string>` ::
 424
 425 OpenID Issuer Url
 426
 427 `--mode` `<ldap | ldap+starttls | ldaps>` ('default =' `ldap`)::
 428
 429 LDAP protocol mode.
 430
 431 `--password` `<string>` ::
 432
 433 LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.
 434
 435 `--port` `<integer> (1 - 65535)` ::
 436
 437 Server port.
 438
 439 `--secure` `<boolean>` ::
 440
 441 Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.
 442
 443 `--server1` `<string>` ::
 444
 445 Server IP address (or DNS name)
 446
 447 `--server2` `<string>` ::
 448
 449 Fallback Server IP address (or DNS name)
 450
 451 `--sslversion` `<tlsv1 | tlsv1_1 | tlsv1_2 | tlsv1_3>` ::
 452
 453 LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!
 454
 455 `--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,scope=<users|groups|both>]` ::
 456
 457 The default options for behavior of synchronizations.
 458
 459 `--sync_attributes` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 460
 461 Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write  'email=mail'. By default, each PVE user field is represented  by an LDAP attribute of the same name.
 462
 463 `--tfa` `type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]` ::
 464
 465 Use Two-factor authentication.
 466
 467 `--user_attr` `\S{2,}` ::
 468
 469 LDAP user attribute name
 470
 471 `--user_classes` `<string>` ('default =' `inetorgperson, posixaccount, person, user`)::
 472
 473 The objectclasses for users.
 474
 475 `--verify` `<boolean>` ('default =' `0`)::
 476
 477 Verify the server's SSL certificate
 478
 479 *pveum realm sync* `<realm>` `[OPTIONS]`
 480
 481 Syncs users and/or groups from the configured LDAP to user.cfg. NOTE:
 482 Synced groups will have the name 'name-$realm', so make sure those groups
 483 do not exist to prevent overwriting.
 484
 485 `<realm>`: `<string>` ::
 486
 487 Authentication domain ID
 488
 489 `--dry-run` `<boolean>` ('default =' `0`)::
 490
 491 If set, does not write anything.
 492
 493 `--enable-new` `<boolean>` ('default =' `1`)::
 494
 495 Enable newly synced users immediately.
 496
 497 `--full` `<boolean>` ::
 498
 499 If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync. Otherwise only syncs information which is not already present, and does not deletes or modifies anything else.
 500
 501 `--purge` `<boolean>` ::
 502
 503 Remove ACLs for users or groups which were removed from the config during a sync.
 504
 505 `--scope` `<both | groups | users>` ::
 506
 507 Select what to sync.
 508
 509 *pveum role add* `<roleid>` `[OPTIONS]`
 510
 511 Create new role.
 512
 513 `<roleid>`: `<string>` ::
 514
 515 no description available
 516
 517 `--privs` `<string>` ::
 518
 519 no description available
 520
 521 *pveum role delete* `<roleid>`
 522
 523 Delete role.
 524
 525 `<roleid>`: `<string>` ::
 526
 527 no description available
 528
 529 *pveum role list* `[FORMAT_OPTIONS]`
 530
 531 Role index.
 532
 533 *pveum role modify* `<roleid>` `[OPTIONS]`
 534
 535 Update an existing role.
 536
 537 `<roleid>`: `<string>` ::
 538
 539 no description available
 540
 541 `--append` `<boolean>` ::
 542
 543 no description available
 544 +
 545 NOTE: Requires option(s): `privs`
 546
 547 `--privs` `<string>` ::
 548
 549 no description available
 550
 551 *pveum roleadd*
 552
 553 An alias for 'pveum role add'.
 554
 555 *pveum roledel*
 556
 557 An alias for 'pveum role delete'.
 558
 559 *pveum rolemod*
 560
 561 An alias for 'pveum role modify'.
 562
 563 *pveum ticket* `<username>` `[OPTIONS]`
 564
 565 Create or verify authentication ticket.
 566
 567 `<username>`: `<string>` ::
 568
 569 User name
 570
 571 `--new-format` `<boolean>` ('default =' `0`)::
 572
 573 With webauthn the format of half-authenticated tickts changed. New clients should pass 1 here and not worry about the old format. The old format is deprecated and will be retired with PVE-8.0
 574
 575 `--otp` `<string>` ::
 576
 577 One-time password for Two-factor authentication.
 578
 579 `--path` `<string>` ::
 580
 581 Verify ticket, and check if user have access 'privs' on 'path'
 582 +
 583 NOTE: Requires option(s): `privs`
 584
 585 `--privs` `<string>` ::
 586
 587 Verify ticket, and check if user have access 'privs' on 'path'
 588 +
 589 NOTE: Requires option(s): `path`
 590
 591 `--realm` `<string>` ::
 592
 593 You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
 594
 595 `--tfa-challenge` `<string>` ::
 596
 597 The signed TFA challenge string the user wants to respond to.
 598
 599 *pveum user add* `<userid>` `[OPTIONS]`
 600
 601 Create new user.
 602
 603 `<userid>`: `<string>` ::
 604
 605 User ID
 606
 607 `--comment` `<string>` ::
 608
 609 no description available
 610
 611 `--email` `<string>` ::
 612
 613 no description available
 614
 615 `--enable` `<boolean>` ('default =' `1`)::
 616
 617 Enable the account (default). You can set this to '0' to disable the account
 618
 619 `--expire` `<integer> (0 - N)` ::
 620
 621 Account expiration date (seconds since epoch). '0' means no expiration date.
 622
 623 `--firstname` `<string>` ::
 624
 625 no description available
 626
 627 `--groups` `<string>` ::
 628
 629 no description available
 630
 631 `--keys` `<string>` ::
 632
 633 Keys for two factor auth (yubico).
 634
 635 `--lastname` `<string>` ::
 636
 637 no description available
 638
 639 `--password` `<string>` ::
 640
 641 Initial password.
 642
 643 *pveum user delete* `<userid>`
 644
 645 Delete user.
 646
 647 `<userid>`: `<string>` ::
 648
 649 User ID
 650
 651 *pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]`
 652
 653 User index.
 654
 655 `--enabled` `<boolean>` ::
 656
 657 Optional filter for enable property.
 658
 659 `--full` `<boolean>` ('default =' `0`)::
 660
 661 Include group and token information.
 662
 663 *pveum user modify* `<userid>` `[OPTIONS]`
 664
 665 Update user configuration.
 666
 667 `<userid>`: `<string>` ::
 668
 669 User ID
 670
 671 `--append` `<boolean>` ::
 672
 673 no description available
 674 +
 675 NOTE: Requires option(s): `groups`
 676
 677 `--comment` `<string>` ::
 678
 679 no description available
 680
 681 `--email` `<string>` ::
 682
 683 no description available
 684
 685 `--enable` `<boolean>` ('default =' `1`)::
 686
 687 Enable the account (default). You can set this to '0' to disable the account
 688
 689 `--expire` `<integer> (0 - N)` ::
 690
 691 Account expiration date (seconds since epoch). '0' means no expiration date.
 692
 693 `--firstname` `<string>` ::
 694
 695 no description available
 696
 697 `--groups` `<string>` ::
 698
 699 no description available
 700
 701 `--keys` `<string>` ::
 702
 703 Keys for two factor auth (yubico).
 704
 705 `--lastname` `<string>` ::
 706
 707 no description available
 708
 709 *pveum user permissions* `[<userid>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
 710
 711 Retrieve effective permissions of given user/token.
 712
 713 `<userid>`: `(?^:^(?^:[^\s:/]+)\@(?^:[A-Za-z][A-Za-z0-9\.\-_]+)(?:!(?^:[A-Za-z][A-Za-z0-9\.\-_]+))?$)` ::
 714
 715 User ID or full API token ID
 716
 717 `--path` `<string>` ::
 718
 719 Only dump this specific path, not the whole tree.
 720
 721 *pveum user tfa delete* `<userid>` `[OPTIONS]`
 722
 723 Delete TFA entries from a user.
 724
 725 `<userid>`: `<string>` ::
 726
 727 User ID
 728
 729 `--id` `<string>` ::
 730
 731 The TFA ID, if none provided, all TFA entries will be deleted.
 732
 733 *pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
 734
 735 Generate a new API token for a specific user. NOTE: returns API token
 736 value, which needs to be stored as it cannot be retrieved afterwards!
 737
 738 `<userid>`: `<string>` ::
 739
 740 User ID
 741
 742 `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
 743
 744 User-specific token identifier.
 745
 746 `--comment` `<string>` ::
 747
 748 no description available
 749
 750 `--expire` `<integer> (0 - N)` ('default =' `same as user`)::
 751
 752 API token expiration date (seconds since epoch). '0' means no expiration date.
 753
 754 `--privsep` `<boolean>` ('default =' `1`)::
 755
 756 Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
 757
 758 *pveum user token list* `<userid>` `[FORMAT_OPTIONS]`
 759
 760 Get user API tokens.
 761
 762 `<userid>`: `<string>` ::
 763
 764 User ID
 765
 766 *pveum user token modify* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
 767
 768 Update API token for a specific user.
 769
 770 `<userid>`: `<string>` ::
 771
 772 User ID
 773
 774 `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
 775
 776 User-specific token identifier.
 777
 778 `--comment` `<string>` ::
 779
 780 no description available
 781
 782 `--expire` `<integer> (0 - N)` ('default =' `same as user`)::
 783
 784 API token expiration date (seconds since epoch). '0' means no expiration date.
 785
 786 `--privsep` `<boolean>` ('default =' `1`)::
 787
 788 Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
 789
 790 *pveum user token permissions* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
 791
 792 Retrieve effective permissions of given token.
 793
 794 `<userid>`: `<string>` ::
 795
 796 User ID
 797
 798 `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
 799
 800 User-specific token identifier.
 801
 802 `--path` `<string>` ::
 803
 804 Only dump this specific path, not the whole tree.
 805
 806 *pveum user token remove* `<userid> <tokenid>` `[FORMAT_OPTIONS]`
 807
 808 Remove API token for a specific user.
 809
 810 `<userid>`: `<string>` ::
 811
 812 User ID
 813
 814 `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
 815
 816 User-specific token identifier.
 817
 818 *pveum useradd*
 819
 820 An alias for 'pveum user add'.
 821
 822 *pveum userdel*
 823
 824 An alias for 'pveum user delete'.
 825
 826 *pveum usermod*
 827
 828 An alias for 'pveum user modify'.
 829
 830