add pvenode.adoc
[pve-docs.git] / 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>]`
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*
81
82 Get information about node's certificates.
83
84 *pvenode cert set* `<certificates> [<key>]` `[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*
105
106 Get node configuration options.
107
108 *pvenode config set* `[OPTIONS]`
109
110 Set node configuration options.
111
112 `--acme` `domains=<domain[;domain;...]> [,account=<name>]` ::
113
114 Node specific ACME settings.
115
116 `--delete` `<string>` ::
117
118 A list of settings you want to delete.
119
120 `--description` `<string>` ::
121
122 Node description/comment.
123
124 `--digest` `<string>` ::
125
126 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
127
128 *pvenode help* `[OPTIONS]`
129
130 Get help about specified command.
131
132 `--extra-args` `<array>` ::
133
134 Shows help for a specific command
135
136 `--verbose` `<boolean>` ::
137
138 Verbose output format.
139
140