Give Feedback

firewalls_info

Generated on 22 Apr 2025 from digitalocean.cloud version v1.0.0

Synopsis

List all firewall on your account.
View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/firewalls_list.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

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.
`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.
`state` (str)	present absent	present	State of the resource, `present` to create, `absent` to destroy.
`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`

Examples

- name: Get firewalls
  digitalocean.cloud.firewalls_info:
    token: "{{ token }}"

Return Values

Key Returned Description

Key	Returned	Description
`error` (dict)	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`firewalls` (list)	always	Firewalls. Sample: `[ { "id": "fb6045f1-cf1d-4ca3-bfac-18832663025b", "inbound_rules": [ { "ports": "80", "protocol": "tcp", "sources": { "load_balancer_uids": [ "4de7ac8b-495b-4884-9a69-1050c6793cd6" ] } }, { "ports": "22", "protocol": "tcp", "sources": { "addresses": [ "18.0.0.0/8" ], "tags": [ "gateway" ] } } ], "name": "firewall", "status": "succeeded" } ]`
`msg` (str)	always	Firewalls result information. Sample: `[ "Current Droplets", "No Droplets" ]`

error
(dict)

failure

DigitalOcean API error.

Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

firewalls
(list)

always

Firewalls.

Sample:

[
  {
    "id": "fb6045f1-cf1d-4ca3-bfac-18832663025b",
    "inbound_rules": [
      {
        "ports": "80",
        "protocol": "tcp",
        "sources": {
          "load_balancer_uids": [
            "4de7ac8b-495b-4884-9a69-1050c6793cd6"
          ]
        }
      },
      {
        "ports": "22",
        "protocol": "tcp",
        "sources": {
          "addresses": [
            "18.0.0.0/8"
          ],
          "tags": [
            "gateway"
          ]
        }
      }
    ],
    "name": "firewall",
    "status": "succeeded"
  }
]

msg
(str)

always

Firewalls result information.

Sample:

[
  "Current Droplets",
  "No Droplets"
]

firewalls_info

Synopsis

Requirements

Parameters

Examples

Return Values

We can't find any results for your search.