community.general.proxmox_pool module – Pool management for Proxmox VE cluster
Note
This module is part of the community.general collection (version 8.6.4).
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_pool
.
New in community.general 7.1.0
Synopsis
Create or delete a pool for Proxmox VE clusters.
For pool members management please consult community.general.proxmox_pool_member module.
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. Requires |
|
Specify the token secret. Requires |
|
Specify the user to authenticate with. |
|
Specify the description for the pool. Parameter is ignored when pool already exists or |
|
The pool ID. |
|
Indicate desired state of the pool. The pool must be empty prior deleting it with Choices:
|
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create new Proxmox VE pool
community.general.proxmox_pool:
api_host: node1
api_user: root@pam
api_password: password
poolid: test
comment: 'New pool'
- name: Delete the Proxmox VE pool
community.general.proxmox_pool:
api_host: node1
api_user: root@pam
api_password: password
poolid: test
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A short message on what the module did. Returned: always Sample: |
|
The pool ID. Returned: success Sample: |