fortios_firewall_multicast_policy – Configure multicast NAT policies in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_firewall_multicast_policy – Configure multicast NAT policies in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- 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

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
firewall_multicast_policy - | Default: null | Configure multicast NAT policies.
| action - | Choices: accept deny | Accept or deny traffic matching the policy.
| dnat - |  | IPv4 DNAT address used for multicast destination addresses.
| dstaddr - |  | Destination address objects.
|  | name - / required |  | Destination address objects. Source firewall.multicast-address.name.
| dstintf - |  | Destination interface name. Source system.interface.name system.zone.name.
| end-port - |  | Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
| id - / required |  | Policy ID.
| logtraffic - | Choices: enable disable | Enable/disable logging traffic accepted by this policy.
| protocol - |  | Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
| snat - | Choices: enable disable | Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT).
| snat-ip - |  | IPv4 address to be used as the source address for NATed traffic.
| srcaddr - |  | Source address objects.
|  | name - / required |  | Source address objects. Source firewall.address.name firewall.addrgrp.name.
| srcintf - |  | Source interface name. Source system.interface.name system.zone.name.
| start-port - |  | Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
| state - | Choices: present absent | Indicates whether to create or remove the object
| status - | Choices: enable disable | Enable/disable this policy.
host - / required |  | FortiOS or FortiGate ip address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol
password - | Default: "" | FortiOS or FortiGate password.
username - / required |  | FortiOS or FortiGate username.
vdom - | Default: "root" | 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.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - 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"

## Return Values

Common return values are documented here, the following are the fields unique to this module:

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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.