pvenode.1-synopsis.adoc

   1 *pvenode* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *pvenode acme account deactivate* `[<name>]`
   4
   5 Deactivate existing ACME account at CA.
   6
   7 `<name>`: `<name>` ('default =' `default`)::
   8
   9 ACME account config file name.
  10
  11 *pvenode acme account info* `[<name>]` `[FORMAT_OPTIONS]`
  12
  13 Return existing ACME account information.
  14
  15 `<name>`: `<name>` ('default =' `default`)::
  16
  17 ACME account config file name.
  18
  19 *pvenode acme account list*
  20
  21 ACMEAccount index.
  22
  23 *pvenode acme account register* `[<name>] {<contact>}` `[OPTIONS]`
  24
  25 Register a new ACME account with a compatible CA.
  26
  27 `<name>`: `<name>` ('default =' `default`)::
  28
  29 ACME account config file name.
  30
  31 `<contact>`: `<string>` ::
  32
  33 Contact email addresses.
  34
  35 `--directory` `^https?://.*` ::
  36
  37 URL of ACME CA directory endpoint.
  38
  39 *pvenode acme account update* `[<name>]` `[OPTIONS]`
  40
  41 Update existing ACME account information with CA. Note: not specifying any
  42 new account information triggers a refresh.
  43
  44 `<name>`: `<name>` ('default =' `default`)::
  45
  46 ACME account config file name.
  47
  48 `--contact` `<string>` ::
  49
  50 Contact email addresses.
  51
  52 *pvenode acme cert order* `[OPTIONS]`
  53
  54 Order a new certificate from ACME-compatible CA.
  55
  56 `--force` `<boolean>` ('default =' `0`)::
  57
  58 Overwrite existing custom certificate.
  59
  60 *pvenode acme cert renew* `[OPTIONS]`
  61
  62 Renew existing certificate from CA.
  63
  64 `--force` `<boolean>` ('default =' `0`)::
  65
  66 Force renewal even if expiry is more than 30 days away.
  67
  68 *pvenode acme cert revoke*
  69
  70 Revoke existing certificate from CA.
  71
  72 *pvenode acme plugin add* `<type> <id>` `[OPTIONS]`
  73
  74 Add ACME plugin configuration.
  75
  76 `<type>`: `<dns | standalone>` ::
  77
  78 ACME challenge type.
  79
  80 `<id>`: `<string>` ::
  81
  82 ACME Plugin ID name
  83
  84 `--api` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | zilore | zone | zonomi>` ::
  85
  86 API plugin name
  87
  88 `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
  89
  90 DNS plugin data. (base64 encoded)
  91
  92 `--disable` `<boolean>` ::
  93
  94 Flag to disable the config.
  95
  96 `--nodes` `<string>` ::
  97
  98 List of cluster node names.
  99
 100 `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
 101
 102 Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
 103
 104 *pvenode acme plugin config* `<id>` `[FORMAT_OPTIONS]`
 105
 106 Get ACME plugin configuration.
 107
 108 `<id>`: `<string>` ::
 109
 110 Unique identifier for ACME plugin instance.
 111
 112 *pvenode acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]`
 113
 114 ACME plugin index.
 115
 116 `--type` `<dns | standalone>` ::
 117
 118 Only list ACME plugins of a specific type
 119
 120 *pvenode acme plugin remove* `<id>`
 121
 122 Delete ACME plugin configuration.
 123
 124 `<id>`: `<string>` ::
 125
 126 Unique identifier for ACME plugin instance.
 127
 128 *pvenode acme plugin set* `<id>` `[OPTIONS]`
 129
 130 Update ACME plugin configuration.
 131
 132 `<id>`: `<string>` ::
 133
 134 ACME Plugin ID name
 135
 136 `--api` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | zilore | zone | zonomi>` ::
 137
 138 API plugin name
 139
 140 `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
 141
 142 DNS plugin data. (base64 encoded)
 143
 144 `--delete` `<string>` ::
 145
 146 A list of settings you want to delete.
 147
 148 `--digest` `<string>` ::
 149
 150 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 151
 152 `--disable` `<boolean>` ::
 153
 154 Flag to disable the config.
 155
 156 `--nodes` `<string>` ::
 157
 158 List of cluster node names.
 159
 160 `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
 161
 162 Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
 163
 164 *pvenode cert delete* `[<restart>]`
 165
 166 DELETE custom certificate chain and key.
 167
 168 `<restart>`: `<boolean>` ('default =' `0`)::
 169
 170 Restart pveproxy.
 171
 172 *pvenode cert info* `[FORMAT_OPTIONS]`
 173
 174 Get information about node's certificates.
 175
 176 *pvenode cert set* `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
 177
 178 Upload or update custom certificate chain and key.
 179
 180 `<certificates>`: `<string>` ::
 181
 182 PEM encoded certificate (chain).
 183
 184 `<key>`: `<string>` ::
 185
 186 PEM encoded private key.
 187
 188 `--force` `<boolean>` ('default =' `0`)::
 189
 190 Overwrite existing custom or ACME certificate files.
 191
 192 `--restart` `<boolean>` ('default =' `0`)::
 193
 194 Restart pveproxy.
 195
 196 *pvenode config get* `[OPTIONS]`
 197
 198 Get node configuration options.
 199
 200 `--property` `<acme | acmedomain0 | acmedomain1 | acmedomain2 | acmedomain3 | acmedomain4 | acmedomain5 | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
 201
 202 Return only a specific property from the node configuration.
 203
 204 *pvenode config set* `[OPTIONS]`
 205
 206 Set node configuration options.
 207
 208 `--acme` `[account=<name>] [,domains=<domain[;domain;...]>]` ::
 209
 210 Node specific ACME settings.
 211
 212 `--acmedomain[n]` `[domain=]<domain> [,alias=<domain>] [,plugin=<name of the plugin configuration>]` ::
 213
 214 ACME domain and validation plugin
 215
 216 `--delete` `<string>` ::
 217
 218 A list of settings you want to delete.
 219
 220 `--description` `<string>` ::
 221
 222 Node description/comment.
 223
 224 `--digest` `<string>` ::
 225
 226 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 227
 228 `--startall-onboot-delay` `<integer> (0 - 300)` ('default =' `0`)::
 229
 230 Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.
 231
 232 `--wakeonlan` `<string>` ::
 233
 234 MAC address for wake on LAN
 235
 236 *pvenode help* `[OPTIONS]`
 237
 238 Get help about specified command.
 239
 240 `--extra-args` `<array>` ::
 241
 242 Shows help for a specific command
 243
 244 `--verbose` `<boolean>` ::
 245
 246 Verbose output format.
 247
 248 *pvenode migrateall* `<target>` `[OPTIONS]`
 249
 250 Migrate all VMs and Containers.
 251
 252 `<target>`: `<string>` ::
 253
 254 Target node.
 255
 256 `--maxworkers` `<integer> (1 - N)` ::
 257
 258 Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!
 259
 260 `--vms` `<string>` ::
 261
 262 Only consider Guests with these IDs.
 263
 264 `--with-local-disks` `<boolean>` ::
 265
 266 Enable live storage migration for local disk
 267
 268 *pvenode startall* `[OPTIONS]`
 269
 270 Start all VMs and containers located on this node (by default only those
 271 with onboot=1).
 272
 273 `--force` `<boolean>` ('default =' `off`)::
 274
 275 Issue start command even if virtual guest have 'onboot' not set or set to off.
 276
 277 `--vms` `<string>` ::
 278
 279 Only consider guests from this comma separated list of VMIDs.
 280
 281 *pvenode stopall* `[OPTIONS]`
 282
 283 Stop all VMs and Containers.
 284
 285 `--vms` `<string>` ::
 286
 287 Only consider Guests with these IDs.
 288
 289 *pvenode task list* `[OPTIONS]` `[FORMAT_OPTIONS]`
 290
 291 Read task list for one node (finished tasks).
 292
 293 `--errors` `<boolean>` ('default =' `0`)::
 294
 295 no description available
 296
 297 `--limit` `<integer> (0 - N)` ('default =' `50`)::
 298
 299 Only list this amount of tasks.
 300
 301 `--source` `<active | all | archive>` ('default =' `archive`)::
 302
 303 List archived, active or all tasks.
 304
 305 `--start` `<integer> (0 - N)` ('default =' `0`)::
 306
 307 List tasks beginning from this offset.
 308
 309 `--typefilter` `<string>` ::
 310
 311 Only list tasks of this type (e.g., vzstart, vzdump).
 312
 313 `--userfilter` `<string>` ::
 314
 315 Only list tasks from this user.
 316
 317 `--vmid` `<integer> (1 - N)` ::
 318
 319 Only list tasks for this VM.
 320
 321 *pvenode task log* `<upid>` `[OPTIONS]`
 322
 323 Read task log.
 324
 325 `<upid>`: `<string>` ::
 326
 327 no description available
 328
 329 `--start` `<integer> (0 - N)` ('default =' `0`)::
 330
 331 no description available
 332
 333 *pvenode task status* `<upid>` `[FORMAT_OPTIONS]`
 334
 335 Read task status.
 336
 337 `<upid>`: `<string>` ::
 338
 339 no description available
 340
 341 *pvenode wakeonlan* `<node>`
 342
 343 Try to wake a node via 'wake on LAN' network packet.
 344
 345 `<node>`: `<string>` ::
 346
 347 target node for wake on LAN packet
 348
 349