community.digitalocean.digital_ocean_firewall_info module – Gather information about DigitalOcean firewalls
Note
This module is part of the community.digitalocean collection (version 1.27.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.digitalocean
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.digitalocean.digital_ocean_firewall_info
.
Synopsis
This module can be used to gather information about DigitalOcean firewalls.
This module was called
digital_ocean_firewall_facts
before Ansible 2.9. The usage did not change.
Aliases: digital_ocean_firewall_facts
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters
Parameter |
Comments |
---|---|
DigitalOcean API base url. Default: |
|
Firewall rule name that can be used to identify and reference a specific firewall rule. |
|
DigitalOcean OAuth token. There are several other environment variables which can be used to provide this value. i.e., - |
|
The timeout in seconds used for polling DigitalOcean’s API. Default: |
|
If set to This should only set to Choices:
|
Examples
- name: Gather information about all firewalls
community.digitalocean.digital_ocean_firewall_info:
oauth_token: "{{ oauth_token }}"
- name: Gather information about a specific firewall by name
community.digitalocean.digital_ocean_firewall_info:
oauth_token: "{{ oauth_token }}"
name: "firewall_name"
- name: Gather information from a firewall rule
community.digitalocean.digital_ocean_firewall_info:
name: SSH
register: resp_out
- set_fact:
firewall_id: "{{ resp_out.data.id }}"
- debug:
msg: "{{ firewall_id }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
DigitalOcean firewall information Returned: success Sample: |