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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_firewall_multicast_policy | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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 more...
- name - Destination address objects. Source firewall.multicast-address.name. type: str 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). type: int required: true more...
- logtraffic - Enable/disable logging traffic accepted by this policy. type: str choices: enable, disable 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 more...
- name - Source address objects. Source firewall.address.name firewall.addrgrp.name. type: str 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...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
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: "65535"
id: "11"
logtraffic: "enable"
name: "default_name_13"
protocol: "0"
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: "1"
status: "enable"
traffic_shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
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