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