5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-21 18:03:45 +03:00

add pvenode.adoc

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
This commit is contained in:
Fabian Grünbichler 2018-04-27 14:02:08 +02:00 committed by Thomas Lamprecht
parent 58e04593ac
commit a99bdc622c
2 changed files with 170 additions and 0 deletions

140
pvenode.1-synopsis.adoc Normal file
View File

@ -0,0 +1,140 @@
*pvenode* `<COMMAND> [ARGS] [OPTIONS]`
*pvenode acme account deactivate* `[<name>]`
Deactivate existing ACME account at CA.
`<name>`: `<name>` ('default =' `default`)::
ACME account config file name.
*pvenode acme account info* `[<name>]`
Return existing ACME account information.
`<name>`: `<name>` ('default =' `default`)::
ACME account config file name.
*pvenode acme account list*
ACMEAccount index.
*pvenode 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.
*pvenode 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.
*pvenode acme cert order* `[OPTIONS]`
Order a new certificate from ACME-compatible CA.
`--force` `<boolean>` ('default =' `0`)::
Overwrite existing custom certificate.
*pvenode acme cert renew* `[OPTIONS]`
Renew existing certificate from CA.
`--force` `<boolean>` ('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* `[<restart>]`
DELETE custom certificate chain and key.
`<restart>`: `<boolean>` ('default =' `0`)::
Restart pveproxy.
*pvenode cert info*
Get information about node's certificates.
*pvenode cert set* `<certificates> [<key>]` `[OPTIONS]`
Upload or update custom certificate chain and key.
`<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 pveproxy.
*pvenode config get*
Get node configuration options.
*pvenode config set* `[OPTIONS]`
Set node configuration options.
`--acme` `domains=<domain[;domain;...]> [,account=<name>]` ::
Node specific ACME settings.
`--delete` `<string>` ::
A list of settings you want to delete.
`--description` `<string>` ::
Node description/comment.
`--digest` `<string>` ::
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` `<array>` ::
Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.

30
pvenode.adoc Normal file
View File

@ -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[]