Alias - Mass Management

STATE: stable

TESTS: Playbook

API Docs: Core - Firewall

Service Docs: Aliases

This module allows you to manage multiple aliases.

It is faster than the ‘alias’ module as it reduces the needed api/http calls.

Info

For more detailed information on what alias types are supported - see the OPNSense documentation.

Multi

Each alias has the attributes as defined in the ansibleguy.opnsense.alias module
To ensure valid configuration - the attributes of each alias get verified using ansible’s built-in verifier

Definition

For basic parameters see: Basic

ansibleguy.opnsense.alias_multi

Definition
Parameter	Type	Required	Default	Aliases	Comment
aliases	dictionary	true	-	-	Dictionary of aliases to manage/configure
fail_verification	boolean	false	false	fail_verify	Fail module if single alias fails the verification
fail_processing	boolean	false	true	fail_proc	Fail module if single alias fails to be processed
state	string	false	‘present’	-	Options: ‘present’, ‘absent’
enabled	boolean	false	true	-	If all aliases should be en- or disabled
output_info	boolean	false	false	info	Enable to show some information on processing at runtime. Will be hidden if the tasks ‘no_log’ parameter is set to ‘true’.
reload	boolean	false	true	-	If the running config should be reloaded on change - this may take some time. For mass-managing items you might want to reload it ‘manually’ after all changes are done => using the ansibleguy.opnsense.reload module.

ansibleguy.opnsense.alias_purge

Definition
Parameter	Type	Required	Default	Aliases	Comment
aliases	dictionary	true	-	-	Configured aliases - to exclude from purging
output_info	boolean	false	false	info	Enable to show some information on processing at runtime. Will be hidden if the tasks ‘no_log’ parameter is set to ‘true’.
action	string	false	‘delete’	-	What to do with the matched aliases. One of: ‘disable’, ‘delete’
filters	dictionary	false	-	-	Field-value pairs to filter on - per example: {type: port} - to only purge aliases of type ‘port’
filter_invert	boolean	false	false	-	If true - it will purge all but the filtered ones
filter_partial	boolean	false	false	-	If true - the filter will also match if it is just a partial value-match
force_all	boolean	false	false	-	If set to true and neither aliases, nor filters are provided - all non-builtin aliases will be purged
fail_all	boolean	false	false	fail	Fail module if single alias fails to be purged
reload	boolean	false	true	-	If the running config should be reloaded on change - this may take some time. For mass-managing items you might want to reload it ‘manually’ after all changes are done => using the ansibleguy.opnsense.reload module.

Examples

- hosts: localhost
  gather_facts: no
  module_defaults:
    group/ansibleguy.opnsense.all:
      firewall: 'opnsense.template.ansibleguy.net'
      api_credential_file: '/home/guy/.secret/opn.key'

    ansibleguy.opnsense.list:
      target: 'alias'

  tasks:
    - name: Creation
      ansibleguy.opnsense.alias_multi:
        fail_verification: true  # default = false; Fail module if single alias fails the verification
        aliases:
          test1:
            content: '1.1.1.1'
          test2:
            content: ['1.1.1.1', '1.1.1.2']
            description: 'to be deleted'
          test3:
            type: 'network'
            content: '10.0.0.0/24'
            description: 'to be disabled'
        # fail_processing: false
        # output_info: false

    - name: Changes
      ansibleguy.opnsense.alias_multi:
        aliases:
          test1:
            content: ['1.1.1.3']
          test2:
            state: 'absent'
          test3:
            enabled: false

    - name: Change state of all
      ansibleguy.opnsense.alias_multi:
        aliases:
          test1:
          test3:
        state: 'absent'
        # enabled: true

    - name: Listing
      ansibleguy.opnsense.list:
      #  target: 'alias'
      register: existing_entries

    - name: Printing aliases
      ansible.builtin.debug:
        var: existing_entries.data

    - name: Purging all non-configured aliases
      ansibleguy.opnsense.alias_purge:
        aliases: {...}
        # action: 'disable'  # default = remove

    - name: Purging all port aliases
      ansibleguy.opnsense.alias_purge:
        filters:  # filtering aliases to purge by alias-parameters
          type: 'port'
        # filter_invert: true  # purge all non-port aliases