dylanturn.opnsense.firewall_alias (1.0.8) — module

Install collection

Install with ansible-galaxy collection install dylanturn.opnsense:==1.0.8

Add to requirements.yml

  collections:
    - name: dylanturn.opnsense
      version: 1.0.8

Description

This module manages an Opnsense firewall alias

Usage examples

Scanned by Steampunk Spotter

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

- name: Create new alias
  turnbros.opnsense.firewall_alias:
    name: hello_world
    description: a description for your alias
    type: port
    content:
        - 42
        - another_port_alias
    enabled: true
    state: present

Inputs

    
name:
    description: Name of the alias
    required: true
    type: str

type:
    description: Type of the alias
    required: false
    type: str

state:
    default: present
    description: Determines wether or not this alias should exist.
    required: false
    type: str

api_key:
    description: The API key used to authenticate with Opnsense
    required: false
    type: str

content:
    default: []
    description: The content of this alias (IP, Cidr, url, ...)
    required: false
    type: list

enabled:
    default: true
    description: This is the message to send to the test module.
    required: false
    type: bool

api_host:
    description: The hostname or IP of the Opnsense device
    required: false
    type: str

api_port:
    description: The port to connection to the Opnsense device on
    required: false
    type: int

api_scheme:
    description: The HTTP scheme to use when connecting to Opnsense
    required: false
    type: str

api_secret:
    description: The API secret used to authenticate with Opnsense
    required: false
    type: str

api_ca_path:
    description: A path to the CA files used to validate the Opnsense cert
    required: false
    type: str

description:
    default: None
    description: Description of the alias
    required: false
    type: str

api_ca_content:
    description: The content of a CA cert that can be used to validate the Opnsense cert
    required: false
    type: str

Outputs

message:
  description: The output message that the test module generates.
  returned: always
  sample: goodbye
  type: str
my_useful_info:
  description: The dictionary containing information about your system.
  returned: always
  sample:
    answer: 42
    foo: bar
  type: dict
original_message:
  description: The original name param that was passed in.
  returned: always
  sample: hello world
  type: str