fortinet.fortios.fortios_firewall_central_snat_map module – Configure IPv4 and IPv6 central SNAT policies in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.6).
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_central_snat_map.
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 central_snat_map 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. |
|
the action indiactor to move an object in the list Choices:
|
|
mkey of target identifier |
|
mkey of target identifier |
|
Enable/Disable logging for task. Choices:
|
|
Configure IPv4 and IPv6 central SNAT policies. |
|
Comment. |
|
IPv4 Destination address. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
IPv6 Destination address. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name. |
|
Destination port or port range (1 to 65535, 0 means any port). |
|
Destination interface name from available interfaces. |
|
Interface name. Source system.interface.name system.zone.name. |
|
Enable/disable source NAT. Choices:
|
|
Enable/disable NAT46. Choices:
|
|
Enable/disable NAT64. Choices:
|
|
Name of the IP pools to be used to translate addresses from available IP Pools. |
|
IP pool name. Source firewall.ippool.name. |
|
IPv6 pools to be used for source NAT. |
|
IPv6 pool name. Source firewall.ippool6.name. |
|
Translated port or port range (1 to 65535, 0 means any port). |
|
IPv4 Original address. |
|
Address name. Source firewall.address.name firewall.addrgrp.name. |
|
IPv6 Original address. |
|
Address name. Source firewall.address6.name firewall.addrgrp6.name. |
|
Original TCP port (1 to 65535, 0 means any port). |
|
Policy ID. see <a href=’#notes’>Notes</a>. |
|
Integer value for the protocol type (0 - 255). |
|
Source interface name from available interfaces. |
|
Interface name. Source system.interface.name system.zone.name. |
|
Enable/disable the active status of this policy. Choices:
|
|
IPv4/IPv6 source NAT. 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:
|
|
mkey of self identifier |
|
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 policyid 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
Adjust object order by moving self after(before) another.
Only one of [after, before] must be specified when action is moving an object.
Examples
- name: Configure IPv4 and IPv6 central SNAT policies.
fortinet.fortios.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: "<you_own_value>"
protocol: "0"
srcintf:
-
name: "default_name_27 (source system.interface.name system.zone.name)"
status: "enable"
type: "ipv4"
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: |