community.proxmox.proxmox_firewall_info module – Manage firewall rules in Proxmox
Note
This module is part of the community.proxmox collection (version 1.4.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_firewall_info.
New in community.proxmox 1.4.0
Synopsis
Get firewall rules at cluster/group/vnet/node/vm level.
Get firewall security groups at cluster level.
Get aliases at cluster/VM level.
Requirements
The below requirements are needed on the host that executes this module.
proxmoxer >= 2.0
requests
Parameters
Parameter |
Comments |
|---|---|
Specify the target host of the Proxmox VE cluster. Uses the |
|
Specify the password to authenticate with. Uses the |
|
Specify the target port of the Proxmox VE cluster. Uses the |
|
Specify the token ID. Uses the |
|
Specify the token secret. Uses the |
|
Specify the user to authenticate with. Uses the |
|
Name of the group to which the rule belongs. Only needed when |
|
Level at which the firewall rule applies. Choices:
|
|
Name of the node. Only needed when |
|
Position of the rule in the list. |
|
If This should only be used on personally controlled sites using self-signed certificates. Uses the Choices:
|
|
ID of the VM to which the rule applies. Only needed when |
|
Name of the virtual network for the rule. Only needed when |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Action group: community.proxmox.proxmox |
Use |
|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Get Cluster level firewall rules, aliases, and security groups
community.proxmox.proxmox_firewall:
api_user: "{{ pc.proxmox.api_user }}"
api_token_id: "{{ pc.proxmox.api_token_id }}"
api_token_secret: "{{ vault.proxmox.api_token_secret }}"
api_host: "{{ pc.proxmox.api_host }}"
validate_certs: false
level: cluster
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
List of alias present at given level. Aliases are only available for cluster and VM level so if any other level it’ll be empty list. Returned: on success Sample: |
|
List of firewall rules at given level. Returned: on success Sample: |
|
List of firewall security groups. This will always be given for cluster level regardless of the level passed. Because only at cluster level we can have firewall security groups. Returned: on success Sample: |
|
List of IP Sets. These are only supported on the Returned: on success Sample: |