fortinet.fortios.fortios_firewall_multicast_policy module – Configure multicast NAT policies in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_multicast_policy
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure multicast NAT policies. |
|
Accept or deny traffic matching the policy. Choices:
|
|
Enable/disable offloading policy traffic for hardware acceleration. Choices:
|
|
Comment. |
|
IPv4 DNAT address used for multicast destination addresses. |
|
Destination address objects. |
|
Destination address objects. Source firewall.multicast-address.name. |
|
Destination interface name. Source system.interface.name system.zone.name. |
|
Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535). |
|
Policy ID ((0 - 4294967294). see <a href=’#notes’>Notes</a>. |
|
Name of an existing IPS sensor. Source ips.sensor.name. |
|
Enable or disable logging. Log all sessions or security profile sessions. Choices:
|
|
Policy name. |
|
Integer value for the protocol type as defined by IANA (0 - 255). |
|
Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Choices:
|
|
IPv4 address to be used as the source address for NATed traffic. |
|
Source address objects. |
|
Source address objects. Source firewall.address.name firewall.addrgrp.name. |
|
Source interface name. Source system.interface.name system.zone.name. |
|
Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535). |
|
Enable/disable this policy. Choices:
|
|
Traffic shaper to apply to traffic forwarded by the multicast policy. Source firewall.shaper.traffic-shaper.name. |
|
Enable to add an IPS security profile to the policy. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
Notes
Note
We highly recommend using your own value as the id instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure multicast NAT policies.
fortinet.fortios.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: "65535"
id: "11"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
logtraffic: "all"
name: "default_name_14"
protocol: "0"
snat: "enable"
snat_ip: "<your_own_value>"
srcaddr:
-
name: "default_name_19 (source firewall.address.name firewall.addrgrp.name)"
srcintf: "<your_own_value> (source system.interface.name system.zone.name)"
start_port: "1"
status: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
utm_status: "enable"
uuid: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |