From a99bdc622c7c8f7471e6c18366df133fc4463a43 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Fabian=20Gr=C3=BCnbichler?= Date: Fri, 27 Apr 2018 14:02:08 +0200 Subject: [PATCH] add pvenode.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabian Grünbichler --- pvenode.1-synopsis.adoc | 140 ++++++++++++++++++++++++++++++++++++++++ pvenode.adoc | 30 +++++++++ 2 files changed, 170 insertions(+) create mode 100644 pvenode.1-synopsis.adoc create mode 100644 pvenode.adoc diff --git a/pvenode.1-synopsis.adoc b/pvenode.1-synopsis.adoc new file mode 100644 index 0000000..46ad2b6 --- /dev/null +++ b/pvenode.1-synopsis.adoc @@ -0,0 +1,140 @@ +*pvenode* ` [ARGS] [OPTIONS]` + +*pvenode acme account deactivate* `[]` + +Deactivate existing ACME account at CA. + +``: `` ('default =' `default`):: + +ACME account config file name. + +*pvenode acme account info* `[]` + +Return existing ACME account information. + +``: `` ('default =' `default`):: + +ACME account config file name. + +*pvenode acme account list* + +ACMEAccount index. + +*pvenode acme account register* `[] {}` `[OPTIONS]` + +Register a new ACME account with a compatible CA. + +``: `` ('default =' `default`):: + +ACME account config file name. + +``: `` :: + +Contact email addresses. + +`--directory` `^https?://.*` :: + +URL of ACME CA directory endpoint. + +*pvenode acme account update* `[]` `[OPTIONS]` + +Update existing ACME account information with CA. Note: not specifying any +new account information triggers a refresh. + +``: `` ('default =' `default`):: + +ACME account config file name. + +`--contact` `` :: + +Contact email addresses. + +*pvenode acme cert order* `[OPTIONS]` + +Order a new certificate from ACME-compatible CA. + +`--force` `` ('default =' `0`):: + +Overwrite existing custom certificate. + +*pvenode acme cert renew* `[OPTIONS]` + +Renew existing certificate from CA. + +`--force` `` ('default =' `0`):: + +Force renewal even if expiry is more than 30 days away. + +*pvenode acme cert revoke* + +Revoke existing certificate from CA. + +*pvenode cert delete* `[]` + +DELETE custom certificate chain and key. + +``: `` ('default =' `0`):: + +Restart pveproxy. + +*pvenode cert info* + +Get information about node's certificates. + +*pvenode cert set* ` []` `[OPTIONS]` + +Upload or update custom certificate chain and key. + +``: `` :: + +PEM encoded certificate (chain). + +``: `` :: + +PEM encoded private key. + +`--force` `` ('default =' `0`):: + +Overwrite existing custom or ACME certificate files. + +`--restart` `` ('default =' `0`):: + +Restart pveproxy. + +*pvenode config get* + +Get node configuration options. + +*pvenode config set* `[OPTIONS]` + +Set node configuration options. + +`--acme` `domains= [,account=]` :: + +Node specific ACME settings. + +`--delete` `` :: + +A list of settings you want to delete. + +`--description` `` :: + +Node description/comment. + +`--digest` `` :: + +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + +*pvenode help* `[OPTIONS]` + +Get help about specified command. + +`--extra-args` `` :: + +Shows help for a specific command + +`--verbose` `` :: + +Verbose output format. + + diff --git a/pvenode.adoc b/pvenode.adoc new file mode 100644 index 0000000..2c2e3d4 --- /dev/null +++ b/pvenode.adoc @@ -0,0 +1,30 @@ +ifdef::manvolnum[] +pvenode(1) +========== +:pve-toplevel: + +NAME +---- + +pvenode - Proxmox VE Node Management + +SYNOPSIS +-------- + +include::pvenode.1-synopsis.adoc[] + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +Proxmox Node Management +======================= +:pve-toplevel: +endif::manvolnum[] + +The {PVE} node management tools (`pvenode`) ... + +ifdef::manvolnum[] +include::pve-copyright.adoc[] +endif::manvolnum[] -- 2.39.2