ansible.builtin.fortios_firewall_multicast_policy (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall feature and multicast_policy category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure multicast NAT policies.
    fortios_firewall_multicast_policy:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      firewall_multicast_policy:
        state: "present"
        action: "accept"
        dnat: "<your_own_value>"
        dstaddr:
         -
            name: "default_name_6 (source firewall.multicast-address.name)"
        dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
        end-port: "8"
        id:  "9"
        logtraffic: "enable"
        protocol: "11"
        snat: "enable"
        snat-ip: "<your_own_value>"
        srcaddr:
         -
            name: "default_name_15 (source firewall.address.name firewall.addrgrp.name)"
        srcintf: "<your_own_value> (source system.interface.name system.zone.name)"
        start-port: "17"
        status: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

firewall_multicast_policy:
    default: null
    description:
    - Configure multicast NAT policies.
    suboptions:
      action:
        choices:
        - accept
        - deny
        description:
        - Accept or deny traffic matching the policy.
      dnat:
        description:
        - IPv4 DNAT address used for multicast destination addresses.
      dstaddr:
        description:
        - Destination address objects.
        suboptions:
          name:
            description:
            - Destination address objects. Source firewall.multicast-address.name.
            required: true
      dstintf:
        description:
        - Destination interface name. Source system.interface.name system.zone.name.
      end-port:
        description:
        - Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535,
          default = 1).
      id:
        description:
        - Policy ID.
        required: true
      logtraffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable logging traffic accepted by this policy.
      protocol:
        description:
        - Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
      snat:
        choices:
        - enable
        - disable
        description:
        - Enable/disable substitution of the outgoing interface IP address for the original
          source IP address (called source NAT or SNAT).
      snat-ip:
        description:
        - IPv4 address to be used as the source address for NATed traffic.
      srcaddr:
        description:
        - Source address objects.
        suboptions:
          name:
            description:
            - Source address objects. Source firewall.address.name firewall.addrgrp.name.
            required: true
      srcintf:
        description:
        - Source interface name. Source system.interface.name system.zone.name.
      start-port:
        description:
        - Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535,
          default = 1).
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this policy.

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str