community.proxmox.proxmox_acme_certificates_info module – Retrieves the list of certificates on a Proxmox VE node.

Note

This module is part of the community.proxmox collection (version 2.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.proxmox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.proxmox.proxmox_acme_certificates_info.

New in community.proxmox 2.0.0

Synopsis

  • Retrieves the list of certificates on a Proxmox VE node.

  • Also returns the ACME configuration (account and domains) from the node config.

Requirements

The below requirements are needed on the host that executes this module.

  • proxmoxer >= 2.3

  • requests

Parameters

Parameter

Comments

api_host

string / required

Specify the target host of the Proxmox VE cluster.

Uses the PROXMOX_HOST environment variable if not specified.

api_otp

string

Specify the OTP.

Uses the PROXMOX_OTP environment variable if not specified.

api_password

string

Specify the password to authenticate with.

Uses the PROXMOX_PASSWORD environment variable if not specified.

api_port

integer

Specify the target port of the Proxmox VE cluster.

Uses the PROXMOX_PORT environment variable if not specified.

api_timeout

integer

Time limit for requests towards the Proxmox VE API.

Default: 5

api_token_id

string

Specify the token ID.

Uses the PROXMOX_TOKEN_ID environment variable if not specified.

api_token_secret

string

Specify the token secret.

Uses the PROXMOX_TOKEN_SECRET environment variable if not specified.

api_user

string / required

Specify the user to authenticate with.

Uses the PROXMOX_USER environment variable if not specified.

ca_path

path

Path to a local certificate, which will be used to verify TLS connections.

Ignored if validate_certs=false.

node_name

string / required

The name of the Proxmox VE node to list certificates for.

validate_certs

boolean

Validate the TLS certificates used for the connection to the Proxmox VE API.

May be set through the environment variable PROXMOX_VALIDATE_CERTS.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

action_group

Action group: community.proxmox.proxmox

Use group/community.proxmox.proxmox in module_defaults to set defaults for this module.

check_mode

Support: full

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

See Also

See also

community.proxmox.proxmox_acme_certificate

Manages ACME SSL certificates for Proxmox VE nodes.

Authentication

Complete guide for the Proxmox API authentication

Examples

- name: List certificates
  community.proxmox.proxmox_acme_certificates_info:
    node_name: pve-node-01

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

account

string

The ACME account name configured on the node.

Returned: on success

certificates

list / elements=dictionary

List of certificates on the node.

Returned: on success

certificate

string

The PEM-encoded certificate data.

Returned: success

fingerprint

string

The certificate fingerprint.

Returned: success

issuer

string

The certificate issuer.

Returned: success

not_after

integer

The certificate expiration timestamp.

Returned: success

not_before

integer

The certificate start timestamp.

Returned: success

subject

string

The certificate subject.

Returned: success

subject_alternative_names

list / elements=string

The certificate subject alternative names (SANs).

Returned: success

domains

list / elements=dictionary

The list of ACME domains configured on the node.

Returned: on success

alias

string

The alias domain used for DNS validation.

Returned: success

domain

string

The domain name.

Returned: success

plugin

string

The DNS plugin used for validation.

Returned: success

Authors

  • Clément Cruau (@PendaGTP)