fortinet.fortios.fortios_firewall_multicast_policy – Configure multicast NAT policies in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_multicast_policy.
New in version 2.8: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and multicast_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
 
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
 
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
|   access_token    string    |    Token-based authentication. Generated from GUI of Fortigate.   |  |||
|   firewall_multicast_policy    dictionary    |    Configure multicast NAT policies.   |  |||
|   action    string    |   
  |    Accept or deny traffic matching the policy.   |  ||
|   dnat    string    |    IPv4 DNAT address used for multicast destination addresses.   |  |||
|   dstaddr    list / elements=string    |    Destination address objects.   |  |||
|   name    string / required    |    Destination address objects. Source firewall.multicast-address.name.   |  |||
|   dstintf    string    |    Destination interface name. Source system.interface.name system.zone.name.   |  |||
|   end_port    integer    |    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535).   |  |||
|   id    integer / required    |    Policy ID.   |  |||
|   logtraffic    string    |   
  |    Enable/disable logging traffic accepted by this policy.   |  ||
|   protocol    integer    |    Integer value for the protocol type as defined by IANA (0 - 255).   |  |||
|   snat    string    |   
  |    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT).   |  ||
|   snat_ip    string    |    IPv4 address to be used as the source address for NATed traffic.   |  |||
|   srcaddr    list / elements=string    |    Source address objects.   |  |||
|   name    string / required    |    Source address objects. Source firewall.address.name firewall.addrgrp.name.   |  |||
|   srcintf    string    |    Source interface name. Source system.interface.name system.zone.name.   |  |||
|   start_port    integer    |    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535).   |  |||
|   state    string    |   
  |    Deprecated  Starting with Ansible 2.9 we recommend using the top-level 'state' parameter.   Indicates whether to create or remove the object.   |  ||
|   status    string    |   
  |    Enable/disable this policy.   |  ||
|   state    string    added in 2.9 of fortinet.fortios    |   
  |    Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.   |  ||
|   vdom    string    |   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
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
 
Examples
- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure multicast NAT policies.
    fortios_firewall_multicast_policy:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_multicast_policy:
        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   |  
Authors
- Link Zheng (@chillancezen)
 - Jie Xue (@JieX19)
 - Hongbin Lu (@fgtdev-hblu)
 - Frank Shen (@frankshen01)
 - Miguel Angel Munoz (@mamunozgonzalez)
 - Nicolas Thomas (@thomnico)
 
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_firewall_multicast_policy_module.html