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 cert delete* `[<restart>]`
  73
  74 DELETE custom certificate chain and key.
  75
  76 `<restart>`: `<boolean>` ('default =' `0`)::
  77
  78 Restart pveproxy.
  79
  80 *pvenode cert info* `[FORMAT_OPTIONS]`
  81
  82 Get information about node's certificates.
  83
  84 *pvenode cert set* `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
  85
  86 Upload or update custom certificate chain and key.
  87
  88 `<certificates>`: `<string>` ::
  89
  90 PEM encoded certificate (chain).
  91
  92 `<key>`: `<string>` ::
  93
  94 PEM encoded private key.
  95
  96 `--force` `<boolean>` ('default =' `0`)::
  97
  98 Overwrite existing custom or ACME certificate files.
  99
 100 `--restart` `<boolean>` ('default =' `0`)::
 101
 102 Restart pveproxy.
 103
 104 *pvenode config get* `[OPTIONS]`
 105
 106 Get node configuration options.
 107
 108 `--property` `<acme | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
 109
 110 Return only a specific property from the node configuration.
 111
 112 *pvenode config set* `[OPTIONS]`
 113
 114 Set node configuration options.
 115
 116 `--acme` `domains=<domain[;domain;...]> [,account=<name>]` ::
 117
 118 Node specific ACME settings.
 119
 120 `--delete` `<string>` ::
 121
 122 A list of settings you want to delete.
 123
 124 `--description` `<string>` ::
 125
 126 Node description/comment.
 127
 128 `--digest` `<string>` ::
 129
 130 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 131
 132 `--startall-onboot-delay` `<integer> (0 - 300)` ('default =' `0`)::
 133
 134 Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.
 135
 136 `--wakeonlan` `<string>` ::
 137
 138 MAC address for wake on LAN
 139
 140 *pvenode help* `[OPTIONS]`
 141
 142 Get help about specified command.
 143
 144 `--extra-args` `<array>` ::
 145
 146 Shows help for a specific command
 147
 148 `--verbose` `<boolean>` ::
 149
 150 Verbose output format.
 151
 152 *pvenode migrateall* `<target>` `[OPTIONS]`
 153
 154 Migrate all VMs and Containers.
 155
 156 `<target>`: `<string>` ::
 157
 158 Target node.
 159
 160 `--maxworkers` `<integer> (1 - N)` ::
 161
 162 Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!
 163
 164 `--vms` `<string>` ::
 165
 166 Only consider Guests with these IDs.
 167
 168 *pvenode startall* `[OPTIONS]`
 169
 170 Start all VMs and containers located on this node (by default only those
 171 with onboot=1).
 172
 173 `--force` `<boolean>` ('default =' `off`)::
 174
 175 Issue start command even if virtual guest have 'onboot' not set or set to off.
 176
 177 `--vms` `<string>` ::
 178
 179 Only consider guests from this comma separated list of VMIDs.
 180
 181 *pvenode stopall* `[OPTIONS]`
 182
 183 Stop all VMs and Containers.
 184
 185 `--vms` `<string>` ::
 186
 187 Only consider Guests with these IDs.
 188
 189 *pvenode task list* `[OPTIONS]` `[FORMAT_OPTIONS]`
 190
 191 Read task list for one node (finished tasks).
 192
 193 `--errors` `<boolean>` ('default =' `0`)::
 194
 195 no description available
 196
 197 `--limit` `<integer> (0 - N)` ('default =' `50`)::
 198
 199 Only list this amount of tasks.
 200
 201 `--source` `<active | all | archive>` ('default =' `archive`)::
 202
 203 List archived, active or all tasks.
 204
 205 `--start` `<integer> (0 - N)` ('default =' `0`)::
 206
 207 List tasks beginning from this offset.
 208
 209 `--typefilter` `<string>` ::
 210
 211 Only list tasks of this type (e.g., vzstart, vzdump).
 212
 213 `--userfilter` `<string>` ::
 214
 215 Only list tasks from this user.
 216
 217 `--vmid` `<integer> (1 - N)` ::
 218
 219 Only list tasks for this VM.
 220
 221 *pvenode task log* `<upid>` `[OPTIONS]`
 222
 223 Read task log.
 224
 225 `<upid>`: `<string>` ::
 226
 227 no description available
 228
 229 `--start` `<integer> (0 - N)` ('default =' `0`)::
 230
 231 no description available
 232
 233 *pvenode task status* `<upid>` `[FORMAT_OPTIONS]`
 234
 235 Read task status.
 236
 237 `<upid>`: `<string>` ::
 238
 239 no description available
 240
 241 *pvenode wakeonlan* `<node>`
 242
 243 Try to wake a node via 'wake on LAN' network packet.
 244
 245 `<node>`: `<string>` ::
 246
 247 target node for wake on LAN packet
 248
 249