fortios_firewall_central_snat_map – Configure IPv4 and IPv6 central SNAT 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 central_snat_map 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 |
v7.2.4 |
v7.4.0 |
|
fortios_firewall_central_snat_map | yes | yes | 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
- action - the action indiactor to move an object in the list type: str choices: move
- self - mkey of self identifier type: str
- after - mkey of target identifier type: str
- before - mkey of target identifier type: str
- state - Indicates whether to create or remove the object. type: str required: false choices: present, absent
- firewall_central_snat_map - Configure IPv4 and IPv6 central SNAT policies. type: dict more...
- comments - Comment. type: str more...
- dst_addr - IPv4 Destination address. type: list member_path: dst_addr:name more...
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
- dst_addr6 - IPv6 Destination address. type: list member_path: dst_addr6:name more...
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true more...
- dst_port - Destination port or port range (1 to 65535, 0 means any port). type: str more...
- dstintf - Destination interface name from available interfaces. type: list member_path: dstintf:name more...
- name - Interface name. Source system.interface.name system.zone.name. type: str required: true more...
- nat - Enable/disable source NAT. type: str choices: disable, enable more...
- nat_ippool - Name of the IP pools to be used to translate addresses from available IP Pools. type: list member_path: nat_ippool:name more...
- name - IP pool name. Source firewall.ippool.name. type: str required: true more...
- nat_ippool6 - IPv6 pools to be used for source NAT. type: list member_path: nat_ippool6:name more...
- name - IPv6 pool name. Source firewall.ippool6.name. type: str required: true more...
- nat_port - Translated port or port range (1 to 65535, 0 means any port). type: str more...
- nat46 - Enable/disable NAT46. type: str choices: enable, disable more...
- nat64 - Enable/disable NAT64. type: str choices: enable, disable more...
- orig_addr - IPv4 Original address. type: list member_path: orig_addr:name more...
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
- orig_addr6 - IPv6 Original address. type: list member_path: orig_addr6:name more...
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true more...
- orig_port - Original TCP port (1 to 65535, 0 means any port). type: str more...
- policyid - Policy ID. type: int required: true more...
- protocol - Integer value for the protocol type (0 - 255). type: int more...
- srcintf - Source interface name from available interfaces. type: list member_path: srcintf:name more...
- name - Interface name. Source system.interface.name system.zone.name. type: str required: true more...
- status - Enable/disable the active status of this policy. type: str choices: enable, disable more...
- type - IPv4/IPv6 source NAT. type: str choices: ipv4, ipv6 more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
Notes¶
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- Adjust object order by moving self after(before) another.
- Only one of [after, before] must be specified when action is moving an object.
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 IPv4 and IPv6 central SNAT policies.
fortios_firewall_central_snat_map:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_central_snat_map:
comments: "<your_own_value>"
dst_addr:
-
name: "default_name_5 (source firewall.address.name firewall.addrgrp.name)"
dst_addr6:
-
name: "default_name_7 (source firewall.address6.name firewall.addrgrp6.name)"
dst_port: "<your_own_value>"
dstintf:
-
name: "default_name_10 (source system.interface.name system.zone.name)"
nat: "disable"
nat_ippool:
-
name: "default_name_13 (source firewall.ippool.name)"
nat_ippool6:
-
name: "default_name_15 (source firewall.ippool6.name)"
nat_port: "<your_own_value>"
nat46: "enable"
nat64: "enable"
orig_addr:
-
name: "default_name_20 (source firewall.address.name firewall.addrgrp.name)"
orig_addr6:
-
name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name)"
orig_port: "<your_own_value>"
policyid: "0"
protocol: "0"
srcintf:
-
name: "default_name_27 (source system.interface.name system.zone.name)"
status: "enable"
type: "ipv4"
uuid: "<your_own_value>"
- name: move firewall.central_snat_map
fortios_firewall_central_snat_map:
vdom: "root"
action: "move"
self: "<mkey of self identifier>"
after: "<mkey of target identifier>"
#before: "<mkey of target identifier>"
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