pveum.1-synopsis.adoc

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