community.general.proxmox_domain_info module – Retrieve information about one or more Proxmox VE domains

Note

This module is part of the community.general collection (version 5.8.3).

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.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.proxmox_domain_info.

New in community.general 1.3.0

Synopsis

  • Retrieve information about one or more Proxmox VE domains.

Requirements

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

  • proxmoxer

  • requests

Parameters

Parameter

Comments

api_host

string / required

Specify the target host of the Proxmox VE cluster.

api_password

string

Specify the password to authenticate with.

You can use PROXMOX_PASSWORD environment variable.

api_token_id

string

added in community.general 1.3.0

Specify the token ID.

api_token_secret

string

added in community.general 1.3.0

Specify the token secret.

api_user

string / required

Specify the user to authenticate with.

domain

aliases: realm, name

string

Restrict results to a specific authentication realm.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false ← (default)

  • true

Examples

- name: List existing domains
  community.general.proxmox_domain_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
  register: proxmox_domains

- name: Retrieve information about the pve domain
  community.general.proxmox_domain_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    domain: pve
  register: proxmox_domain_pve

Return Values

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

Key

Description

proxmox_domains

list / elements=dictionary

List of authentication domains.

Returned: always, but can be empty

comment

string

Short description of the realm.

Returned: on success

digest

string

Realm hash.

Returned: on success, can be absent

realm

string

Realm name.

Returned: on success

type

string

Realm type.

Returned: on success

Authors

  • Tristan Le Guern (@tleguern)