community.digitalocean.digital_ocean_firewall_info – Gather information about DigitalOcean firewalls
Note
This plugin is part of the community.digitalocean collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.digitalocean.
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_factsbefore Ansible 2.9. The usage did not change.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| name  string  | Firewall rule name that can be used to identify and reference a specific firewall rule. | |
| oauth_token  string  | DigitalOcean OAuth token. There are several other environment variables which can be used to provide this value. i.e., - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' and 'OAUTH_TOKEN' aliases: api_token | |
| timeout  integer  | Default: 30 | The timeout in seconds used for polling DigitalOcean's API. | 
| validate_certs  boolean  | 
 | If set to  no, the SSL certificates will not be validated.This should only set to  noused on personally controlled sites using self-signed certificates. | 
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 | Returned | Description | 
|---|---|---|
| data  list / elements=string  | success | DigitalOcean firewall information Sample: [{'created_at': '2018-01-15T07:04:25Z', 'droplet_ids': [87426985], 'id': '435tbg678-1db53-32b6-t543-28322569t252', 'inbound_rules': [{'ports': '9100', 'protocol': 'tcp', 'sources': {'addresses': ['1.1.1.1']}}], 'name': 'metrics', 'outbound_rules': [], 'pending_changes': [], 'status': 'succeeded', 'tags': []}] | 
Authors
- Anthony Bond (@BondAnthony)
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_firewall_info_module.html