community.proxmox.proxmox_acme_plugin_dns module – Manage ACME DNS plugins on a Proxmox VE.

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

New in community.proxmox 2.0.0

Synopsis

  • Create, update or delete a DNS challenge ACME plugin configuration.

  • Requires root@pam authentication.

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.

data

dictionary

DNS plugin settings as string key/value pairs.

disable

boolean

Disable this plugin configuration.

Choices:

  • false ← (default)

  • true

name

aliases: id

string / required

The ACME plugin instance identifier.

plugin

string

DNS API implementation name (for example cf for Cloudflare or googledomains for Google Cloud DNS).

state

string

Desired state of the ACME DNS plugin.

Choices:

  • "present" ← (default)

  • "absent"

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)

validation_delay

integer

Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records (0 - 172800).

Default: 30

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

ACME DNS API Challenge Plugin

ACME DNS API Challenge Plugin (Proxmox documentation)

Authentication

Complete guide for the Proxmox API authentication

Examples

- name: Configure ACME Plugin DNS (Cloudflare)
  community.proxmox.proxmox_acme_plugin_dns:
    name: cloudflare
    plugin: cf
    data:
      CF_Account_ID: example
      CF_Token: example

- name: Remove ACME DNS plugin
  community.proxmox.proxmox_acme_plugin_dns:
    name: cloudflare
    state: absent

Return Values

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

Key

Description

data

dictionary

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

Returned: on success when state=present

digest

string

Digest of the plugin configuration.

Returned: on success when state=present

disable

boolean

Whether the plugin configuration is disabled.

Returned: on success when state=present

msg

string

Short description of the action taken.

Returned: always

name

string

ACME plugin instance identifier.

Returned: on success

plugin

string

DNS API implementation name.

Returned: on success when state=present

validation_delay

integer

Validation delay in seconds.

Returned: on success when state=present

Authors

  • Clément Cruau (@PendaGTP)