mirror of
https://git.proxmox.com/git/pmg-docs
synced 2025-10-04 00:10:40 +00:00
run make update
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
5c82f3eace
commit
c5ccf1abe2
File diff suppressed because it is too large
Load Diff
@ -30,7 +30,7 @@ Server address (IP or DNS name).
|
||||
|
||||
Use SSL.
|
||||
|
||||
`target`: `(?:[^\s\/\\@]+\@[^\s\/\\@]+)` ::
|
||||
`target`: `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
|
||||
|
||||
The target email address (where to deliver fetched mails).
|
||||
|
||||
|
||||
@ -4,6 +4,10 @@
|
||||
|
||||
Backup the system configuration.
|
||||
|
||||
`--notify` `<always | error | never>` ('default =' `never`)::
|
||||
|
||||
Specify when to notify via e-mail
|
||||
|
||||
`--statistic` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Backup statistic databases.
|
||||
@ -24,7 +28,7 @@ Verbose output format.
|
||||
|
||||
List all stored backups (files named proxmox-backup_{DATE}.tgz).
|
||||
|
||||
*pmgbackup proxmox-backup backup* `<remote>`
|
||||
*pmgbackup proxmox-backup backup* `<remote>` `[OPTIONS]`
|
||||
|
||||
Create a new backup and prune the backup group afterwards, if configured.
|
||||
|
||||
@ -32,6 +36,14 @@ Create a new backup and prune the backup group afterwards, if configured.
|
||||
|
||||
Proxmox Backup Server ID.
|
||||
|
||||
`--notify` `<always | error | never>` ('default =' `never`)::
|
||||
|
||||
Specify when to notify via e-mail
|
||||
|
||||
`--statistic` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Backup statistic databases.
|
||||
|
||||
*pmgbackup proxmox-backup forget* `<remote> <backup-id> <backup-time>`
|
||||
|
||||
Forget a snapshot
|
||||
@ -108,6 +120,10 @@ Flag to disable (deactivate) the entry.
|
||||
|
||||
Certificate SHA 256 fingerprint.
|
||||
|
||||
`--include-statistics` `<boolean>` ::
|
||||
|
||||
Include statistics in scheduled backups
|
||||
|
||||
`--keep-daily` `<N>` ::
|
||||
|
||||
Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
|
||||
@ -132,6 +148,10 @@ Keep backups for the last <N> different weeks. If there ismore than one backup f
|
||||
|
||||
Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
|
||||
|
||||
`--notify` `<always | error | never>` ::
|
||||
|
||||
Specify when to notify via e-mail
|
||||
|
||||
`--password` `<password>` ::
|
||||
|
||||
Password or API token secret for the user on the Proxmox Backup Server.
|
||||
@ -140,7 +160,7 @@ Password or API token secret for the user on the Proxmox Backup Server.
|
||||
|
||||
Proxmox Backup Server address.
|
||||
|
||||
`--username` `(?:[^\s\/\\@]+\@[^\s\/\\@]+)` ::
|
||||
`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
|
||||
|
||||
Username or API token ID on the Proxmox Backup Server
|
||||
|
||||
@ -184,6 +204,10 @@ Flag to disable (deactivate) the entry.
|
||||
|
||||
Certificate SHA 256 fingerprint.
|
||||
|
||||
`--include-statistics` `<boolean>` ::
|
||||
|
||||
Include statistics in scheduled backups
|
||||
|
||||
`--keep-daily` `<N>` ::
|
||||
|
||||
Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
|
||||
@ -208,6 +232,10 @@ Keep backups for the last <N> different weeks. If there ismore than one backup f
|
||||
|
||||
Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
|
||||
|
||||
`--notify` `<always | error | never>` ::
|
||||
|
||||
Specify when to notify via e-mail
|
||||
|
||||
`--password` `<password>` ::
|
||||
|
||||
Password or API token secret for the user on the Proxmox Backup Server.
|
||||
@ -216,7 +244,7 @@ Password or API token secret for the user on the Proxmox Backup Server.
|
||||
|
||||
Proxmox Backup Server address.
|
||||
|
||||
`--username` `(?:[^\s\/\\@]+\@[^\s\/\\@]+)` ::
|
||||
`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
|
||||
|
||||
Username or API token ID on the Proxmox Backup Server
|
||||
|
||||
|
||||
@ -36,11 +36,15 @@ IP address.
|
||||
|
||||
SSL certificate fingerprint.
|
||||
|
||||
*pmgcm join_cmd*
|
||||
*pmgcm join-cmd*
|
||||
|
||||
Prints the command for joining an new node to the cluster. You need to
|
||||
execute the command on the new node.
|
||||
|
||||
*pmgcm join_cmd*
|
||||
|
||||
An alias for 'pmgcm join-cmd'.
|
||||
|
||||
*pmgcm promote*
|
||||
|
||||
Promote current node to become the new master.
|
||||
@ -61,4 +65,8 @@ Synchronize cluster configuration.
|
||||
|
||||
Optional IP address for master node.
|
||||
|
||||
*pmgcm update-fingerprints*
|
||||
|
||||
Notify master to refresh all certificate fingerprints
|
||||
|
||||
|
||||
|
||||
@ -1,5 +1,182 @@
|
||||
*pmgconfig* `<COMMAND> [ARGS] [OPTIONS]`
|
||||
|
||||
*pmgconfig acme account deactivate* `[<name>]` `[OPTIONS]`
|
||||
|
||||
Deactivate existing ACME account at CA.
|
||||
|
||||
`<name>`: `<name>` ('default =' `default`)::
|
||||
|
||||
ACME account config file name.
|
||||
|
||||
`--force` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Delete account data even if the server refuses to deactivate the account.
|
||||
|
||||
*pmgconfig acme account info* `[<name>]` `[FORMAT_OPTIONS]`
|
||||
|
||||
Return existing ACME account information.
|
||||
|
||||
`<name>`: `<name>` ('default =' `default`)::
|
||||
|
||||
ACME account config file name.
|
||||
|
||||
*pmgconfig acme account list*
|
||||
|
||||
ACME account index.
|
||||
|
||||
*pmgconfig acme account register* `[<name>] {<contact>}` `[OPTIONS]`
|
||||
|
||||
Register a new ACME account with a compatible CA.
|
||||
|
||||
`<name>`: `<name>` ('default =' `default`)::
|
||||
|
||||
ACME account config file name.
|
||||
|
||||
`<contact>`: `<string>` ::
|
||||
|
||||
Contact email addresses.
|
||||
|
||||
`--directory` `^https?://.*` ::
|
||||
|
||||
URL of ACME CA directory endpoint.
|
||||
|
||||
*pmgconfig acme account update* `[<name>]` `[OPTIONS]`
|
||||
|
||||
Update existing ACME account information with CA. Note: not specifying any
|
||||
new account information triggers a refresh.
|
||||
|
||||
`<name>`: `<name>` ('default =' `default`)::
|
||||
|
||||
ACME account config file name.
|
||||
|
||||
`--contact` `<string>` ::
|
||||
|
||||
Contact email addresses.
|
||||
|
||||
*pmgconfig acme cert order* `<type>` `[OPTIONS]`
|
||||
|
||||
Order a new certificate from ACME-compatible CA.
|
||||
|
||||
`<type>`: `<api | smtp>` ::
|
||||
|
||||
The TLS certificate type (API or SMTP certificate).
|
||||
|
||||
`--force` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Overwrite existing custom certificate.
|
||||
|
||||
*pmgconfig acme cert renew* `<type>` `[OPTIONS]`
|
||||
|
||||
Renew existing certificate from CA.
|
||||
|
||||
`<type>`: `<api | smtp>` ::
|
||||
|
||||
The TLS certificate type (API or SMTP certificate).
|
||||
|
||||
`--force` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Force renewal even if expiry is more than 30 days away.
|
||||
|
||||
*pmgconfig acme cert revoke* `<type>`
|
||||
|
||||
Revoke existing certificate from CA.
|
||||
|
||||
`<type>`: `<api | smtp>` ::
|
||||
|
||||
The TLS certificate type (API or SMTP certificate).
|
||||
|
||||
*pmgconfig acme plugin add* `<type> <id>` `[OPTIONS]`
|
||||
|
||||
Add ACME plugin configuration.
|
||||
|
||||
`<type>`: `<dns | standalone>` ::
|
||||
|
||||
ACME challenge type.
|
||||
|
||||
`<id>`: `<string>` ::
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | 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 | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` ::
|
||||
|
||||
API plugin name
|
||||
|
||||
`--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
|
||||
|
||||
DNS plugin data. (base64 encoded)
|
||||
|
||||
`--disable` `<boolean>` ::
|
||||
|
||||
Flag to disable the config.
|
||||
|
||||
`--nodes` `<string>` ::
|
||||
|
||||
List of cluster node names.
|
||||
|
||||
`--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
|
||||
|
||||
Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
|
||||
|
||||
*pmgconfig acme plugin config* `<id>` `[FORMAT_OPTIONS]`
|
||||
|
||||
Get ACME plugin configuration.
|
||||
|
||||
`<id>`: `<string>` ::
|
||||
|
||||
Unique identifier for ACME plugin instance.
|
||||
|
||||
*pmgconfig acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
ACME plugin index.
|
||||
|
||||
`--type` `<dns | standalone>` ::
|
||||
|
||||
Only list ACME plugins of a specific type
|
||||
|
||||
*pmgconfig acme plugin remove* `<id>`
|
||||
|
||||
Delete ACME plugin configuration.
|
||||
|
||||
`<id>`: `<string>` ::
|
||||
|
||||
Unique identifier for ACME plugin instance.
|
||||
|
||||
*pmgconfig acme plugin set* `<id>` `[OPTIONS]`
|
||||
|
||||
Update ACME plugin configuration.
|
||||
|
||||
`<id>`: `<string>` ::
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | 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 | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` ::
|
||||
|
||||
API plugin name
|
||||
|
||||
`--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
|
||||
|
||||
DNS plugin data. (base64 encoded)
|
||||
|
||||
`--delete` `<string>` ::
|
||||
|
||||
A list of settings you want to delete.
|
||||
|
||||
`--digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`--disable` `<boolean>` ::
|
||||
|
||||
Flag to disable the config.
|
||||
|
||||
`--nodes` `<string>` ::
|
||||
|
||||
List of cluster node names.
|
||||
|
||||
`--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
|
||||
|
||||
Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
|
||||
|
||||
*pmgconfig apicert* `[OPTIONS]`
|
||||
|
||||
Generate /etc/pmg/pmg-api.pem (self signed certificate for GUI and REST
|
||||
@ -9,6 +186,46 @@ API).
|
||||
|
||||
Overwrite existing certificate.
|
||||
|
||||
*pmgconfig cert delete* `<type> [<restart>]`
|
||||
|
||||
DELETE custom certificate chain and key.
|
||||
|
||||
`<type>`: `<api | smtp>` ::
|
||||
|
||||
The TLS certificate type (API or SMTP certificate).
|
||||
|
||||
`<restart>`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Restart pmgproxy.
|
||||
|
||||
*pmgconfig cert info* `[FORMAT_OPTIONS]`
|
||||
|
||||
Get information about the node's certificates.
|
||||
|
||||
*pmgconfig cert set* `<type> <certificates> <key>` `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
Upload or update custom certificate chain and key.
|
||||
|
||||
`<type>`: `<api | smtp>` ::
|
||||
|
||||
The TLS certificate type (API or SMTP certificate).
|
||||
|
||||
`<certificates>`: `<string>` ::
|
||||
|
||||
PEM encoded certificate (chain).
|
||||
|
||||
`<key>`: `<string>` ::
|
||||
|
||||
PEM encoded private key.
|
||||
|
||||
`--force` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Overwrite existing custom or ACME certificate files.
|
||||
|
||||
`--restart` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Restart services.
|
||||
|
||||
*pmgconfig dkim_record*
|
||||
|
||||
Get the public key for the configured selector, prepared as DKIM TXT record
|
||||
|
||||
Loading…
Reference in New Issue
Block a user