New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
name
-
|
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
no used on personally controlled sites using self-signed certificates. |
- name: Gather facts about all firewalls
digital_ocean_firewall_facts:
oauth_token: "{{ oauth_token }}"
- name: Gather facts about a specific firewall by name
digital_ocean_firewall_facts:
oauth_token: "{{ oauth_token }}"
name: "firewall_name"
- name: Gather information from a firewall rule
digital_ocean_firewall_facts:
name: SSH
register: resp_out
- set_fact:
firewall_id: "{{ resp_out.data.id }}"
- debug:
msg: "{{ firewall_id }}"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
data
list
|
success |
DigitalOcean firewall facts
Sample:
[{'status': 'succeeded', 'pending_changes': [], 'name': 'metrics', 'tags': [], 'created_at': '2018-01-15T07:04:25Z', 'inbound_rules': [{'sources': {'addresses': ['1.1.1.1']}, 'protocol': 'tcp', 'ports': '9100'}], 'droplet_ids': [87426985], 'outbound_rules': [], 'id': '435tbg678-1db53-32b6-t543-28322569t252'}]
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.