1 *pmgconfig* `<COMMAND> [ARGS] [OPTIONS]`
3 *pmgconfig acme account deactivate* `[<name>]` `[OPTIONS]`
5 Deactivate existing ACME account at CA.
7 `<name>`: `<name>` ('default =' `default`)::
9 ACME account config file name.
11 `--force` `<boolean>` ('default =' `0`)::
13 Delete account data even if the server refuses to deactivate the account.
15 *pmgconfig acme account info* `[<name>]` `[FORMAT_OPTIONS]`
17 Return existing ACME account information.
19 `<name>`: `<name>` ('default =' `default`)::
21 ACME account config file name.
23 *pmgconfig acme account list*
27 *pmgconfig acme account register* `[<name>] {<contact>}` `[OPTIONS]`
29 Register a new ACME account with a compatible CA.
31 `<name>`: `<name>` ('default =' `default`)::
33 ACME account config file name.
35 `<contact>`: `<string>` ::
37 Contact email addresses.
39 `--directory` `^https?://.*` ::
41 URL of ACME CA directory endpoint.
43 *pmgconfig acme account update* `[<name>]` `[OPTIONS]`
45 Update existing ACME account information with CA. Note: not specifying any
46 new account information triggers a refresh.
48 `<name>`: `<name>` ('default =' `default`)::
50 ACME account config file name.
52 `--contact` `<string>` ::
54 Contact email addresses.
56 *pmgconfig acme cert order* `<type>` `[OPTIONS]`
58 Order a new certificate from ACME-compatible CA.
60 `<type>`: `<api | smtp>` ::
62 The TLS certificate type (API or SMTP certificate).
64 `--force` `<boolean>` ('default =' `0`)::
66 Overwrite existing custom certificate.
68 *pmgconfig acme cert renew* `<type>` `[OPTIONS]`
70 Renew existing certificate from CA.
72 `<type>`: `<api | smtp>` ::
74 The TLS certificate type (API or SMTP certificate).
76 `--force` `<boolean>` ('default =' `0`)::
78 Force renewal even if expiry is more than 30 days away.
80 *pmgconfig acme cert revoke* `<type>`
82 Revoke existing certificate from CA.
84 `<type>`: `<api | smtp>` ::
86 The TLS certificate type (API or SMTP certificate).
88 *pmgconfig acme plugin add* `<type> <id>` `[OPTIONS]`
90 Add ACME plugin configuration.
92 `<type>`: `<dns | standalone>` ::
100 `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
104 `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
106 DNS plugin data. (base64 encoded)
108 `--disable` `<boolean>` ::
110 Flag to disable the config.
112 `--nodes` `<string>` ::
114 List of cluster node names.
116 `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
118 Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
120 *pmgconfig acme plugin config* `<id>` `[FORMAT_OPTIONS]`
122 Get ACME plugin configuration.
124 `<id>`: `<string>` ::
126 Unique identifier for ACME plugin instance.
128 *pmgconfig acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]`
132 `--type` `<dns | standalone>` ::
134 Only list ACME plugins of a specific type
136 *pmgconfig acme plugin remove* `<id>`
138 Delete ACME plugin configuration.
140 `<id>`: `<string>` ::
142 Unique identifier for ACME plugin instance.
144 *pmgconfig acme plugin set* `<id>` `[OPTIONS]`
146 Update ACME plugin configuration.
148 `<id>`: `<string>` ::
152 `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
156 `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
158 DNS plugin data. (base64 encoded)
160 `--delete` `<string>` ::
162 A list of settings you want to delete.
164 `--digest` `<string>` ::
166 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
168 `--disable` `<boolean>` ::
170 Flag to disable the config.
172 `--nodes` `<string>` ::
174 List of cluster node names.
176 `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
178 Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
180 *pmgconfig apicert* `[OPTIONS]`
182 Generate /etc/pmg/pmg-api.pem (self signed certificate for GUI and REST
185 `--force` `<boolean>` ('default =' `0`)::
187 Overwrite existing certificate.
189 *pmgconfig cert delete* `<type> [<restart>]`
191 DELETE custom certificate chain and key.
193 `<type>`: `<api | smtp>` ::
195 The TLS certificate type (API or SMTP certificate).
197 `<restart>`: `<boolean>` ('default =' `0`)::
201 *pmgconfig cert info* `[FORMAT_OPTIONS]`
203 Get information about the node's certificates.
205 *pmgconfig cert set* `<type> <certificates> <key>` `[OPTIONS]` `[FORMAT_OPTIONS]`
207 Upload or update custom certificate chain and key.
209 `<type>`: `<api | smtp>` ::
211 The TLS certificate type (API or SMTP certificate).
213 `<certificates>`: `<string>` ::
215 PEM encoded certificate (chain).
217 `<key>`: `<string>` ::
219 PEM encoded private key.
221 `--force` `<boolean>` ('default =' `0`)::
223 Overwrite existing custom or ACME certificate files.
225 `--restart` `<boolean>` ('default =' `0`)::
229 *pmgconfig dkim_record*
231 Get the public key for the configured selector, prepared as DKIM TXT record
233 *pmgconfig dkim_set* `--keysize <integer> --selector <string>` `[OPTIONS]`
235 Generate a new private key for selector. All future mail will be signed
238 `--force` `<boolean>` ::
240 Overwrite existing key
242 `--keysize` `<integer> (1024 - N)` ::
244 Number of bits for the RSA-Key
246 `--selector` `<string>` ::
252 Print configuration setting which can be used in templates.
254 *pmgconfig help* `[OPTIONS]`
256 Get help about specified command.
258 `--extra-args` `<array>` ::
260 Shows help for a specific command
262 `--verbose` `<boolean>` ::
264 Verbose output format.
268 Generate required files in /etc/pmg/
272 Synchronize the LDAP database.
274 *pmgconfig sync* `[OPTIONS]`
276 Synchronize Proxmox Mail Gateway configurations with system configuration.
278 `--restart` `<boolean>` ('default =' `0`)::
280 Restart services if necessary.
282 *pmgconfig tlscert* `[OPTIONS]`
284 Generate /etc/pmg/pmg-tls.pem (self signed certificate for encrypted SMTP
287 `--force` `<boolean>` ('default =' `0`)::
289 Overwrite existing certificate.