You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

pvenode.1-synopsis.adoc 4.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. *pvenode* `<COMMAND> [ARGS] [OPTIONS]`
  2. *pvenode acme account deactivate* `[<name>]`
  3. Deactivate existing ACME account at CA.
  4. `<name>`: `<name>` ('default =' `default`)::
  5. ACME account config file name.
  6. *pvenode acme account info* `[<name>]` `[FORMAT_OPTIONS]`
  7. Return existing ACME account information.
  8. `<name>`: `<name>` ('default =' `default`)::
  9. ACME account config file name.
  10. *pvenode acme account list*
  11. ACMEAccount index.
  12. *pvenode acme account register* `[<name>] {<contact>}` `[OPTIONS]`
  13. Register a new ACME account with a compatible CA.
  14. `<name>`: `<name>` ('default =' `default`)::
  15. ACME account config file name.
  16. `<contact>`: `<string>` ::
  17. Contact email addresses.
  18. `--directory` `^https?://.*` ::
  19. URL of ACME CA directory endpoint.
  20. *pvenode acme account update* `[<name>]` `[OPTIONS]`
  21. Update existing ACME account information with CA. Note: not specifying any
  22. new account information triggers a refresh.
  23. `<name>`: `<name>` ('default =' `default`)::
  24. ACME account config file name.
  25. `--contact` `<string>` ::
  26. Contact email addresses.
  27. *pvenode acme cert order* `[OPTIONS]`
  28. Order a new certificate from ACME-compatible CA.
  29. `--force` `<boolean>` ('default =' `0`)::
  30. Overwrite existing custom certificate.
  31. *pvenode acme cert renew* `[OPTIONS]`
  32. Renew existing certificate from CA.
  33. `--force` `<boolean>` ('default =' `0`)::
  34. Force renewal even if expiry is more than 30 days away.
  35. *pvenode acme cert revoke*
  36. Revoke existing certificate from CA.
  37. *pvenode cert delete* `[<restart>]`
  38. DELETE custom certificate chain and key.
  39. `<restart>`: `<boolean>` ('default =' `0`)::
  40. Restart pveproxy.
  41. *pvenode cert info* `[FORMAT_OPTIONS]`
  42. Get information about node's certificates.
  43. *pvenode cert set* `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
  44. Upload or update custom certificate chain and key.
  45. `<certificates>`: `<string>` ::
  46. PEM encoded certificate (chain).
  47. `<key>`: `<string>` ::
  48. PEM encoded private key.
  49. `--force` `<boolean>` ('default =' `0`)::
  50. Overwrite existing custom or ACME certificate files.
  51. `--restart` `<boolean>` ('default =' `0`)::
  52. Restart pveproxy.
  53. *pvenode config get*
  54. Get node configuration options.
  55. *pvenode config set* `[OPTIONS]`
  56. Set node configuration options.
  57. `--acme` `domains=<domain[;domain;...]> [,account=<name>]` ::
  58. Node specific ACME settings.
  59. `--delete` `<string>` ::
  60. A list of settings you want to delete.
  61. `--description` `<string>` ::
  62. Node description/comment.
  63. `--digest` `<string>` ::
  64. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
  65. `--wakeonlan` `<string>` ::
  66. MAC address for wake on LAN
  67. *pvenode help* `[OPTIONS]`
  68. Get help about specified command.
  69. `--extra-args` `<array>` ::
  70. Shows help for a specific command
  71. `--verbose` `<boolean>` ::
  72. Verbose output format.
  73. *pvenode migrateall* `<target>` `[OPTIONS]`
  74. Migrate all VMs and Containers.
  75. `<target>`: `<string>` ::
  76. Target node.
  77. `--maxworkers` `<integer> (1 - N)` ::
  78. Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!
  79. `--vms` `<string>` ::
  80. Only consider Guests with these IDs.
  81. *pvenode startall* `[OPTIONS]`
  82. Start all VMs and containers located on this node (by default only those
  83. with onboot=1).
  84. `--force` `<boolean>` ('default =' `off`)::
  85. Issue start command even if virtual guest have 'onboot' not set or set to off.
  86. `--vms` `<string>` ::
  87. Only consider guests from this comma separated list of VMIDs.
  88. *pvenode stopall* `[OPTIONS]`
  89. Stop all VMs and Containers.
  90. `--vms` `<string>` ::
  91. Only consider Guests with these IDs.
  92. *pvenode task list* `[OPTIONS]` `[FORMAT_OPTIONS]`
  93. Read task list for one node (finished tasks).
  94. `--errors` `<boolean>` ('default =' `0`)::
  95. no description available
  96. `--limit` `<integer> (0 - N)` ('default =' `50`)::
  97. Only list this amount of tasks.
  98. `--source` `<active | all | archive>` ('default =' `archive`)::
  99. List archived, active or all tasks.
  100. `--start` `<integer> (0 - N)` ('default =' `0`)::
  101. List tasks beginning from this offset.
  102. `--typefilter` `<string>` ::
  103. Only list tasks of this type (e.g., vzstart, vzdump).
  104. `--userfilter` `<string>` ::
  105. Only list tasks from this user.
  106. `--vmid` `<integer> (1 - N)` ::
  107. Only list tasks for this VM.
  108. *pvenode task log* `<upid>` `[OPTIONS]`
  109. Read task log.
  110. `<upid>`: `<string>` ::
  111. no description available
  112. `--start` `<integer> (0 - N)` ('default =' `0`)::
  113. no description available
  114. *pvenode task status* `<upid>` `[FORMAT_OPTIONS]`
  115. Read task status.
  116. `<upid>`: `<string>` ::
  117. no description available
  118. *pvenode wakeonlan* `<node>`
  119. Try to wake a node via 'wake on LAN' network packet.
  120. `<node>`: `<string>` ::
  121. target node for wake on LAN packet