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 3.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
.
To use it in a playbook, specify: community.general.proxmox_domain_info
.
New in version 1.3.0: of community.general
Requirements
The below requirements are needed on the host that executes this module.
proxmoxer
requests
Parameters
Parameter |
Comments |
---|---|
Specify the target host of the Proxmox VE cluster. |
|
Specify the password to authenticate with. You can use |
|
Specify the token ID. |
|
Specify the token secret. |
|
Specify the user to authenticate with. |
|
Restrict results to a specific authentication realm. |
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
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 |
---|---|
List of authentication domains. Returned: always, but can be empty |
|
Short description of the realm. Returned: on success |
|
Realm hash. Returned: on success, can be absent |
|
Realm name. Returned: on success |
|
Realm type. Returned: on success |
Authors
Tristan Le Guern (@tleguern)