fortios_firewall_multicast_policy – Configure multicast NAT policies in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_multicast_policy - Configure multicast NAT policies. type: dict more...
- action - Accept or deny traffic matching the policy. type: str choices: accept, deny more...
- auto_asic_offload - Enable/disable offloading policy traffic for hardware acceleration. type: str choices: enable, disable more...
- comments - Comment. type: str more...
- dnat - IPv4 DNAT address used for multicast destination addresses. type: str more...
- dstaddr - Destination address objects. type: list member_path: dstaddr:name more...
- name - Destination address objects. Source firewall.multicast-address.name. type: str required: true more...
- dstintf - Destination interface name. Source system.interface.name system.zone.name. type: str more...
- end_port - Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535). type: int more...
- id - Policy ID ((0 - 4294967294). see Notes. type: int required: true more...
- ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str more...
- logtraffic - Enable or disable logging. Log all sessions or security profile sessions. type: str choices: all, utm, disable, enable more...
- name - Policy name. type: str more...
- protocol - Integer value for the protocol type as defined by IANA (0 - 255). type: int more...
- snat - Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). type: str choices: enable, disable more...
- snat_ip - IPv4 address to be used as the source address for NATed traffic. type: str more...
- srcaddr - Source address objects. type: list member_path: srcaddr:name more...
- name - Source address objects. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
- srcintf - Source interface name. Source system.interface.name system.zone.name. type: str more...
- start_port - Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535). type: int more...
- status - Enable/disable this policy. type: str choices: enable, disable more...
- traffic_shaper - Traffic shaper to apply to traffic forwarded by the multicast policy. Source firewall.shaper.traffic-shaper.name. type: str more...
- utm_status - Enable to add an IPS security profile to the policy. type: str choices: enable, disable more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
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
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.