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 role add* `<roleid>` `[OPTIONS]`
 140
 141 Create new role.
 142
 143 `<roleid>`: `<string>` ::
 144
 145 no description available
 146
 147 `--privs` `<string>` ::
 148
 149 no description available
 150
 151 *pveum role delete* `<roleid>`
 152
 153 Delete role.
 154
 155 `<roleid>`: `<string>` ::
 156
 157 no description available
 158
 159 *pveum role list* `[FORMAT_OPTIONS]`
 160
 161 Role index.
 162
 163 *pveum role modify* `<roleid>` `[OPTIONS]`
 164
 165 Update an existing role.
 166
 167 `<roleid>`: `<string>` ::
 168
 169 no description available
 170
 171 `--append` `<boolean>` ::
 172
 173 no description available
 174 +
 175 NOTE: Requires option(s): `privs`
 176
 177 `--privs` `<string>` ::
 178
 179 no description available
 180
 181 *pveum roleadd*
 182
 183 An alias for 'pveum role add'.
 184
 185 *pveum roledel*
 186
 187 An alias for 'pveum role delete'.
 188
 189 *pveum rolemod*
 190
 191 An alias for 'pveum role modify'.
 192
 193 *pveum ticket* `<username>` `[OPTIONS]`
 194
 195 Create or verify authentication ticket.
 196
 197 `<username>`: `<string>` ::
 198
 199 User name
 200
 201 `--otp` `<string>` ::
 202
 203 One-time password for Two-factor authentication.
 204
 205 `--path` `<string>` ::
 206
 207 Verify ticket, and check if user have access 'privs' on 'path'
 208 +
 209 NOTE: Requires option(s): `privs`
 210
 211 `--privs` `<string>` ::
 212
 213 Verify ticket, and check if user have access 'privs' on 'path'
 214 +
 215 NOTE: Requires option(s): `path`
 216
 217 `--realm` `<string>` ::
 218
 219 You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
 220
 221 *pveum user add* `<userid>` `[OPTIONS]`
 222
 223 Create new user.
 224
 225 `<userid>`: `<string>` ::
 226
 227 User ID
 228
 229 `--comment` `<string>` ::
 230
 231 no description available
 232
 233 `--email` `<string>` ::
 234
 235 no description available
 236
 237 `--enable` `<boolean>` ('default =' `1`)::
 238
 239 Enable the account (default). You can set this to '0' to disable the account
 240
 241 `--expire` `<integer> (0 - N)` ::
 242
 243 Account expiration date (seconds since epoch). '0' means no expiration date.
 244
 245 `--firstname` `<string>` ::
 246
 247 no description available
 248
 249 `--groups` `<string>` ::
 250
 251 no description available
 252
 253 `--keys` `<string>` ::
 254
 255 Keys for two factor auth (yubico).
 256
 257 `--lastname` `<string>` ::
 258
 259 no description available
 260
 261 `--password` `<string>` ::
 262
 263 Initial password.
 264
 265 *pveum user delete* `<userid>`
 266
 267 Delete user.
 268
 269 `<userid>`: `<string>` ::
 270
 271 User ID
 272
 273 *pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]`
 274
 275 User index.
 276
 277 `--enabled` `<boolean>` ::
 278
 279 Optional filter for enable property.
 280
 281 `--full` `<boolean>` ('default =' `0`)::
 282
 283 Include group and token information.
 284
 285 *pveum user modify* `<userid>` `[OPTIONS]`
 286
 287 Update user configuration.
 288
 289 `<userid>`: `<string>` ::
 290
 291 User ID
 292
 293 `--append` `<boolean>` ::
 294
 295 no description available
 296 +
 297 NOTE: Requires option(s): `groups`
 298
 299 `--comment` `<string>` ::
 300
 301 no description available
 302
 303 `--email` `<string>` ::
 304
 305 no description available
 306
 307 `--enable` `<boolean>` ('default =' `1`)::
 308
 309 Enable the account (default). You can set this to '0' to disable the account
 310
 311 `--expire` `<integer> (0 - N)` ::
 312
 313 Account expiration date (seconds since epoch). '0' means no expiration date.
 314
 315 `--firstname` `<string>` ::
 316
 317 no description available
 318
 319 `--groups` `<string>` ::
 320
 321 no description available
 322
 323 `--keys` `<string>` ::
 324
 325 Keys for two factor auth (yubico).
 326
 327 `--lastname` `<string>` ::
 328
 329 no description available
 330
 331 *pveum user permissions* `[<userid>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
 332
 333 Retrieve effective permissions of given user/token.
 334
 335 `<userid>`: `(?^:^(?^:[^\s:/]+)\@(?^:[A-Za-z][A-Za-z0-9\.\-_]+)(?:!(?^:[A-Za-z][A-Za-z0-9\.\-_]+))?$)` ::
 336
 337 User ID or full API token ID
 338
 339 `--path` `<string>` ::
 340
 341 Only dump this specific path, not the whole tree.
 342
 343 *pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
 344
 345 Generate a new API token for a specific user. NOTE: returns API token
 346 value, which needs to be stored as it cannot be retrieved afterwards!
 347
 348 `<userid>`: `<string>` ::
 349
 350 User ID
 351
 352 `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
 353
 354 User-specific token identifier.
 355
 356 `--comment` `<string>` ::
 357
 358 no description available
 359
 360 `--expire` `<integer> (0 - N)` ('default =' `same as user`)::
 361
 362 API token expiration date (seconds since epoch). '0' means no expiration date.
 363
 364 `--privsep` `<boolean>` ('default =' `1`)::
 365
 366 Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
 367
 368 *pveum user token list* `<userid>` `[FORMAT_OPTIONS]`
 369
 370 Get user API tokens.
 371
 372 `<userid>`: `<string>` ::
 373
 374 User ID
 375
 376 *pveum user token modify* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
 377
 378 Update API token for a specific user.
 379
 380 `<userid>`: `<string>` ::
 381
 382 User ID
 383
 384 `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
 385
 386 User-specific token identifier.
 387
 388 `--comment` `<string>` ::
 389
 390 no description available
 391
 392 `--expire` `<integer> (0 - N)` ('default =' `same as user`)::
 393
 394 API token expiration date (seconds since epoch). '0' means no expiration date.
 395
 396 `--privsep` `<boolean>` ('default =' `1`)::
 397
 398 Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
 399
 400 *pveum user token permissions* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
 401
 402 Retrieve effective permissions of given token.
 403
 404 `<userid>`: `<string>` ::
 405
 406 User ID
 407
 408 `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
 409
 410 User-specific token identifier.
 411
 412 `--path` `<string>` ::
 413
 414 Only dump this specific path, not the whole tree.
 415
 416 *pveum user token remove* `<userid> <tokenid>` `[FORMAT_OPTIONS]`
 417
 418 Remove API token for a specific user.
 419
 420 `<userid>`: `<string>` ::
 421
 422 User ID
 423
 424 `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
 425
 426 User-specific token identifier.
 427
 428 *pveum useradd*
 429
 430 An alias for 'pveum user add'.
 431
 432 *pveum userdel*
 433
 434 An alias for 'pveum user delete'.
 435
 436 *pveum usermod*
 437
 438 An alias for 'pveum user modify'.
 439
 440