community.proxmox.proxmox_acme_plugin_info module – Retrieves a single ACME plugin

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_plugin_info.

New in community.proxmox 2.0.0

Synopsis

  • Retrieves a single ACME plugin by plugin ID name.

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.

name

aliases: id

string / required

The ACME Plugin ID name.

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

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

diff_mode

Support: none

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_plugin_dns

Manage ACME DNS plugins on a Proxmox VE.

community.proxmox.proxmox_acme_plugins_info

Retrieves the list of ACME plugins.

Authentication

Complete guide for the Proxmox API authentication

Examples

- name: Get ACME plugin example
  community.proxmox.proxmox_acme_plugin_info:
    name: example

Return Values

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

Key

Description

data

dictionary

Plugin settings as string key/value pairs (value are masked).

Returned: on success

digest

string

Digest of the plugin configuration.

Returned: on success

disable

boolean

Whether the plugin configuration is disabled.

Returned: on success

name

string

ACME plugin instance identifier.

Returned: on success

plugin

string

API implementation name.

Returned: on success

type

string

ACME challenge type (dns, standalone).

Returned: on success

validation_delay

integer

Validation delay in seconds.

Returned: on success

Authors

  • Clément Cruau (@PendaGTP)