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

From Get docs
Ansible/docs/2.11/collections/community/general/proxmox domain info module


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

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

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


New in version 1.3.0: of community.general


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 Choices/Defaults 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 1.3.0 of community.general

Specify the token ID.

api_token_secret

string

added in 1.3.0 of community.general

Specify the token secret.

api_user

string / required

Specify the user to authenticate with.

domain

string

Restrict results to a specific authentication realm.


aliases: realm, name

validate_certs

boolean

  • no

  • yes

If no, SSL certificates will not be validated.

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



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 Returned Description

proxmox_domains

list / elements=dictionary

always, but can be empty

List of authentication domains.


comment

string

on success

Short description of the realm.


digest

string

on success, can be absent

Realm hash.


realm

string

on success

Realm name.


type

string

on success

Realm type.





Authors

  • Tristan Le Guern (@Aversiste)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/proxmox_domain_info_module.html