NAME

pvenode - Proxmox VE Node Management

SYNOPSIS

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.

DESCRIPTION

The Proxmox VE node management tool (pvenode) allows to control node specific settings and resources.

Currently pvenode allows to set a node’s description and to manage the node’s SSL certificates used for the API and the web GUI through pveproxy.

EXAMPLES

pvenode cert set certificate.crt certificate.key -force

Install an externally provided certificate. Both files need to be PEM encoded. certificate.key contains the private key and certificate.crt contains the whole certificate chain.

pvenode acme account register default mail@example.invalid
pvenode config set --acme domains=example.invalid
pvenode acme cert order
systemctl restart pveproxy

Setup ACME account and order a certificate for local node.

Copyright © 2007-2017 Proxmox Server Solutions GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/