Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_firewall_multicast_policy_module.html

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 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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.10: 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.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
firewall_multicast_policy
dictionary
Configure multicast NAT policies.
action
string
    Choices:
  • accept
  • deny
Accept or deny traffic matching the policy.
auto_asic_offload
string
    Choices:
  • enable
  • disable
Enable/disable offloading policy traffic for hardware acceleration.
comments
string
Comment.
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
    Choices:
  • enable
  • disable
Enable/disable logging traffic accepted by this policy.
name
string
Policy name.
protocol
integer
Integer value for the protocol type as defined by IANA (0 - 255).
snat
string
    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
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).
status
string
    Choices:
  • enable
  • disable
Enable/disable this policy.
uuid
string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
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"
        auto_asic_offload: "enable"
        comments: "<your_own_value>"
        dnat: "<your_own_value>"
        dstaddr:
         -
            name: "default_name_8 (source firewall.multicast-address.name)"
        dstintf: "<your_own_value> (source system.interface.name system.zone.name)"
        end_port: "10"
        id:  "11"
        logtraffic: "enable"
        name: "default_name_13"
        protocol: "14"
        snat: "enable"
        snat_ip: "<your_own_value>"
        srcaddr:
         -
            name: "default_name_18 (source firewall.address.name firewall.addrgrp.name)"
        srcintf: "<your_own_value> (source system.interface.name system.zone.name)"
        start_port: "20"
        status: "enable"
        uuid: "<your_own_value>"

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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_multicast_policy_module.html