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 `--users` `<string>` ::
  24
  25 List of users.
  26
  27 *pveum acl list* `[FORMAT_OPTIONS]`
  28
  29 Get Access Control List (ACLs).
  30
  31 *pveum acl modify* `<path> --roles <string>` `[OPTIONS]`
  32
  33 Update Access Control List (add or remove permissions).
  34
  35 `<path>`: `<string>` ::
  36
  37 Access control path
  38
  39 `--groups` `<string>` ::
  40
  41 List of groups.
  42
  43 `--propagate` `<boolean>` ('default =' `1`)::
  44
  45 Allow to propagate (inherit) permissions.
  46
  47 `--roles` `<string>` ::
  48
  49 List of roles.
  50
  51 `--users` `<string>` ::
  52
  53 List of users.
  54
  55 *pveum acldel*
  56
  57 An alias for 'pveum acl delete'.
  58
  59 *pveum aclmod*
  60
  61 An alias for 'pveum acl modify'.
  62
  63 *pveum group add* `<groupid>` `[OPTIONS]`
  64
  65 Create new group.
  66
  67 `<groupid>`: `<string>` ::
  68
  69 no description available
  70
  71 `--comment` `<string>` ::
  72
  73 no description available
  74
  75 *pveum group delete* `<groupid>`
  76
  77 Delete group.
  78
  79 `<groupid>`: `<string>` ::
  80
  81 no description available
  82
  83 *pveum group list* `[FORMAT_OPTIONS]`
  84
  85 Group index.
  86
  87 *pveum group modify* `<groupid>` `[OPTIONS]`
  88
  89 Update group data.
  90
  91 `<groupid>`: `<string>` ::
  92
  93 no description available
  94
  95 `--comment` `<string>` ::
  96
  97 no description available
  98
  99 *pveum groupadd*
 100
 101 An alias for 'pveum group add'.
 102
 103 *pveum groupdel*
 104
 105 An alias for 'pveum group delete'.
 106
 107 *pveum groupmod*
 108
 109 An alias for 'pveum group modify'.
 110
 111 *pveum help* `[OPTIONS]`
 112
 113 Get help about specified command.
 114
 115 `--extra-args` `<array>` ::
 116
 117 Shows help for a specific command
 118
 119 `--verbose` `<boolean>` ::
 120
 121 Verbose output format.
 122
 123 *pveum passwd* `<userid>`
 124
 125 Change user password.
 126
 127 `<userid>`: `<string>` ::
 128
 129 User ID
 130
 131 *pveum role add* `<roleid>` `[OPTIONS]`
 132
 133 Create new role.
 134
 135 `<roleid>`: `<string>` ::
 136
 137 no description available
 138
 139 `--privs` `<string>` ::
 140
 141 no description available
 142
 143 *pveum role delete* `<roleid>`
 144
 145 Delete role.
 146
 147 `<roleid>`: `<string>` ::
 148
 149 no description available
 150
 151 *pveum role list* `[FORMAT_OPTIONS]`
 152
 153 Role index.
 154
 155 *pveum role modify* `<roleid>` `[OPTIONS]`
 156
 157 Update an existing role.
 158
 159 `<roleid>`: `<string>` ::
 160
 161 no description available
 162
 163 `--append` `<boolean>` ::
 164
 165 no description available
 166 +
 167 NOTE: Requires option(s): `privs`
 168
 169 `--privs` `<string>` ::
 170
 171 no description available
 172
 173 *pveum roleadd*
 174
 175 An alias for 'pveum role add'.
 176
 177 *pveum roledel*
 178
 179 An alias for 'pveum role delete'.
 180
 181 *pveum rolemod*
 182
 183 An alias for 'pveum role modify'.
 184
 185 *pveum ticket* `<username>` `[OPTIONS]`
 186
 187 Create or verify authentication ticket.
 188
 189 `<username>`: `<string>` ::
 190
 191 User name
 192
 193 `--otp` `<string>` ::
 194
 195 One-time password for Two-factor authentication.
 196
 197 `--path` `<string>` ::
 198
 199 Verify ticket, and check if user have access 'privs' on 'path'
 200 +
 201 NOTE: Requires option(s): `privs`
 202
 203 `--privs` `<string>` ::
 204
 205 Verify ticket, and check if user have access 'privs' on 'path'
 206 +
 207 NOTE: Requires option(s): `path`
 208
 209 `--realm` `<string>` ::
 210
 211 You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
 212
 213 *pveum user add* `<userid>` `[OPTIONS]`
 214
 215 Create new user.
 216
 217 `<userid>`: `<string>` ::
 218
 219 User ID
 220
 221 `--comment` `<string>` ::
 222
 223 no description available
 224
 225 `--email` `<string>` ::
 226
 227 no description available
 228
 229 `--enable` `<boolean>` ('default =' `1`)::
 230
 231 Enable the account (default). You can set this to '0' to disable the account
 232
 233 `--expire` `<integer> (0 - N)` ::
 234
 235 Account expiration date (seconds since epoch). '0' means no expiration date.
 236
 237 `--firstname` `<string>` ::
 238
 239 no description available
 240
 241 `--groups` `<string>` ::
 242
 243 no description available
 244
 245 `--keys` `<string>` ::
 246
 247 Keys for two factor auth (yubico).
 248
 249 `--lastname` `<string>` ::
 250
 251 no description available
 252
 253 `--password` `<string>` ::
 254
 255 Initial password.
 256
 257 *pveum user delete* `<userid>`
 258
 259 Delete user.
 260
 261 `<userid>`: `<string>` ::
 262
 263 User ID
 264
 265 *pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]`
 266
 267 User index.
 268
 269 `--enabled` `<boolean>` ::
 270
 271 Optional filter for enable property.
 272
 273 *pveum user modify* `<userid>` `[OPTIONS]`
 274
 275 Update user configuration.
 276
 277 `<userid>`: `<string>` ::
 278
 279 User ID
 280
 281 `--append` `<boolean>` ::
 282
 283 no description available
 284 +
 285 NOTE: Requires option(s): `groups`
 286
 287 `--comment` `<string>` ::
 288
 289 no description available
 290
 291 `--email` `<string>` ::
 292
 293 no description available
 294
 295 `--enable` `<boolean>` ('default =' `1`)::
 296
 297 Enable the account (default). You can set this to '0' to disable the account
 298
 299 `--expire` `<integer> (0 - N)` ::
 300
 301 Account expiration date (seconds since epoch). '0' means no expiration date.
 302
 303 `--firstname` `<string>` ::
 304
 305 no description available
 306
 307 `--groups` `<string>` ::
 308
 309 no description available
 310
 311 `--keys` `<string>` ::
 312
 313 Keys for two factor auth (yubico).
 314
 315 `--lastname` `<string>` ::
 316
 317 no description available
 318
 319 *pveum useradd*
 320
 321 An alias for 'pveum user add'.
 322
 323 *pveum userdel*
 324
 325 An alias for 'pveum user delete'.
 326
 327 *pveum usermod*
 328
 329 An alias for 'pveum user modify'.
 330
 331