fortinet.fortios.fortios_firewall_central_snat_map – Configure central SNAT policies in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_central_snat_map
.
New in version 2.8: of fortinet.fortios
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.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|||
firewall_central_snat_map
dictionary
|
Configure central SNAT policies.
|
|||
comments
string
|
Comment.
|
|||
dst_addr
list /
elements=string
|
Destination address name from available addresses.
|
|||
name
string /
required
|
Address name. Source firewall.address.name firewall.addrgrp.name.
|
|||
dstintf
list /
elements=string
|
Destination interface name from available interfaces.
|
|||
name
string /
required
|
Interface name. Source system.interface.name system.zone.name.
|
|||
nat
string
|
|
Enable/disable source NAT.
|
||
nat_ippool
list /
elements=string
|
Name of the IP pools to be used to translate addresses from available IP Pools.
|
|||
name
string /
required
|
IP pool name. Source firewall.ippool.name.
|
|||
nat_port
string
|
Translated port or port range (0 to 65535).
|
|||
orig_addr
list /
elements=string
|
Original address.
|
|||
name
string /
required
|
Address name. Source firewall.address.name firewall.addrgrp.name.
|
|||
orig_port
string
|
Original TCP port (0 to 65535).
|
|||
policyid
integer /
required
|
Policy ID.
|
|||
protocol
integer
|
Integer value for the protocol type (0 - 255).
|
|||
srcintf
list /
elements=string
|
Source interface name from available interfaces.
|
|||
name
string /
required
|
Interface name. Source system.interface.name system.zone.name.
|
|||
state
string
|
|
Deprecated
Starting with Ansible 2.9 we recommend using the top-level 'state' parameter.
Indicates whether to create or remove the object.
|
||
status
string
|
|
Enable/disable the active status of this policy.
|
||
state
string
added in 2.9 of fortinet.fortios
|
|
Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
|
||
vdom
string
|
Default:
"root"
|
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.
|
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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 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)" dstintf: - name: "default_name_7 (source system.interface.name system.zone.name)" nat: "disable" nat_ippool: - name: "default_name_10 (source firewall.ippool.name)" nat_port: "<your_own_value>" orig_addr: - name: "default_name_13 (source firewall.address.name firewall.addrgrp.name)" orig_port: "<your_own_value>" policyid: "15" protocol: "16" srcintf: - name: "default_name_18 (source system.interface.name system.zone.name)" status: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
status
string
|
always |
Indication of the operation's result
Sample:
success
|
vdom
string
|
always |
Virtual domain used
Sample:
root
|
version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_firewall_central_snat_map_module.html