Create or delete firewalls.
DigitalOcean Cloud Firewalls provide the ability to restrict network access to and from a Droplet allowing you to define which ports will accept inbound or outbound connections.
View the create API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Firewalls.
| Parameter | Choices | Default | Comments |
|---|---|---|---|
client_override_options(dict) |
Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options. | ||
droplet_ids(list) |
An array containing the IDs of the Droplets assigned to the firewall. | ||
inbound_rules(list) |
Array of inbound firewall rules. | ||
module_override_options(dict) |
Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options. | ||
name(str) |
A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). | ||
outbound_rules(list) |
Array of outbound firewall rules. | ||
state(str) |
|
present | State of the resource, present to create, absent to destroy. |
tags(list) |
A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. | ||
timeout(int) |
300 | Polling timeout in seconds. | |
token(str) |
DigitalOcean API token. There are several environment variables which can be used to provide this value. DIGITALOCEAN_ACCESS_TOKEN, DIGITALOCEAN_TOKEN, DO_API_TOKEN, DO_API_KEY, DO_OAUTH_TOKEN and OAUTH_TOKEN |
- name: Create firewall
digitalocean.cloud.firewall:
token: "{{ token }}"
state: present
name: firewall
inbound_rules:
- protocol: tcp
ports: 80
sources:
- load_balancer_uids:
- "4de7ac8b-495b-4884-9a69-1050c6793cd6"
outbound_rules:
- protocol: tcp
ports: 80
destinations:
- addresses:
- "0.0.0.0/0"
- "::/0"
droplet_ids:
- 8043964
| Key | Returned | Description |
|---|---|---|
error(dict) |
failure |
DigitalOcean API error.
Sample: |
firewall(dict) |
always |
Firewall information.
Sample: |
msg(str) |
always |
Droplet result information.
Sample: |