hetzner.hcloud.firewall_info module – Gather infos about the Hetzner Cloud Firewalls.
Note
This module is part of the hetzner.hcloud collection (version 3.1.1).
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 hetzner.hcloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: hetzner.hcloud.firewall_info
.
Synopsis
Gather facts about your Hetzner Cloud Firewalls.
Aliases: hcloud_firewall_info
Requirements
The below requirements are needed on the host that executes this module.
python-dateutil >= 2.7.5
requests >=2.20
Parameters
Parameter |
Comments |
---|---|
The API Endpoint for the Hetzner Cloud. You can also set this option by using the Default: |
|
The API Token for the Hetzner Cloud. You can also set this option by using the |
|
The ID of the Firewall you want to get. The module will fail if the provided ID is invalid. |
|
The label selector for the Firewalls you want to get. |
|
The name for the Firewall you want to get. |
See Also
See also
- Documentation for Hetzner Cloud API
Complete reference for the Hetzner Cloud API.
Examples
- name: Gather hcloud Firewall infos
hetzner.hcloud.firewall_info:
register: output
- name: Print the gathered infos
debug:
var: output
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of Firewalls. Returned: always |
|
List of Resources the Firewall is applied to. Returned: always |
|
List of Resources the Firewall label selector is applied to. Returned: if |
|
ID of the Server. Returned: success Sample: |
|
Type of resource referenced. Returned: success Can only return:
Sample: |
|
Label selector value. Returned: success Sample: |
|
ID of the server. Returned: success Sample: |
|
Type of the resource. Returned: success Can only return:
Sample: |
|
Numeric identifier of the firewall. Returned: always Sample: |
|
User-defined labels (key-value pairs). Returned: always |
|
Name of the firewall. Returned: always Sample: |
|
List of rules the firewall contain. Returned: always |
|
User defined description of this rule. Returned: always Sample: |
|
List of destination CIDRs that are allowed within this rule. Returned: always Sample: |
|
The direction of the firewall rule. Returned: always Sample: |
|
The port or port range allowed by this rule. Returned: if Sample: |
|
The protocol of the firewall rule. Returned: always Sample: |
|
List of source CIDRs that are allowed within this rule. Returned: always Sample: |