fmgr_pkg_firewall_centralsnatmap – Configure central SNAT policies.¶
New in version 2.0.0.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
|||||||||||
True | |||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
||
True | True | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
||||
True | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
|||||||||
True | True | True | |||||||||
7.4.0 |
|||||||||||
True |
Parameters¶
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_firewall_centralsnatmap - Configure central SNAT policies. type: dict
- dst-addr - Destination address name from available addresses. type: str more...
- dstintf - Destination interface name from available interfaces. type: str 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: str more...
- nat-port - Translated port or port range (0 to 65535). type: str more...
- orig-addr - Original address. type: str more...
- orig-port - Original TCP port (0 to 65535). type: int more...
- policyid - Policy ID. type: int more...
- protocol - Integer value for the protocol type (0 - 255). type: int more...
- srcintf - Source interface name from available interfaces. type: str more...
- status - Enable/disable the active status of this policy. type: str choices: [disable, enable] more...
- comments - Comment. type: str more...
- dst-addr6 - IPv6 Destination address. type: str more...
- nat-ippool6 - IPv6 pools to be used for source NAT. type: str more...
- orig-addr6 - IPv6 Original address. type: str 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...
- nat46 - Enable/disable NAT46. type: str choices: [disable, enable] more...
- nat64 - Enable/disable NAT64. type: str choices: [disable, enable] more...
- dst-port - Destination port or port range (1 to 65535, 0 means any port). type: str more...
Notes¶
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples¶
- hosts: fortimanager00
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure central SNAT policies.
fmgr_pkg_firewall_centralsnatmap:
bypass_validation: False
adom: ansible
pkg: ansible # package name
state: present
pkg_firewall_centralsnatmap:
dst-addr: 'ansible-test1'
nat: enable
orig-addr: 'ansible-test1'
policyid: 2
status: disable
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the central SNAT policies
fmgr_fact:
facts:
selector: 'pkg_firewall_centralsnatmap'
params:
adom: 'ansible'
pkg: 'ansible' # package name
central-snat-map: 'your_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:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0