community.general.digital_ocean_firewall_facts (0.1.4) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.4

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.4

Description

This module can be used to gather information about DigitalOcean firewalls.

This module was called C(digital_ocean_firewall_facts) before Ansible 2.9. The usage did not change.

Requirements

• python >= 2.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather information about all firewalls
  digital_ocean_firewall_info:
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather information about a specific firewall by name
  digital_ocean_firewall_info:
    oauth_token: "{{ oauth_token }}"
    name: "firewall_name"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather information from a firewall rule
  digital_ocean_firewall_info:
    name: SSH
  register: resp_out

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- set_fact:
    firewall_id: "{{ resp_out.data.id }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- debug:
    msg: "{{ firewall_id }}"

Inputs

    
name:
    description:
    - Firewall rule name that can be used to identify and reference a specific firewall
      rule.
    required: false

timeout:
    default: 30
    description:
    - The timeout in seconds used for polling DigitalOcean's API.
    type: int

oauth_token:
    aliases:
    - api_token
    description:
    - 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'
    type: str

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

Outputs

data:
  description: DigitalOcean firewall information
  returned: success
  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: []
  type: list