- source
fmgr_pkg_firewall_centralsnatmap.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- 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 (Alias name: dst-addr) Destination address name from available addresses. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dstintf Destination interface name from available interfaces. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- nat Enable/disable source nat. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- nat_ippool (Alias name: nat-ippool) Name of the ip pools to be used to translate addresses from available ip pools. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- nat_port (Alias name: nat-port) Translated port or port range (0 to 65535). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- orig_addr (Alias name: orig-addr) Original address. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- orig_port (Alias name: orig-port) Original tcp port (0 to 65535). type: int or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- policyid Policy id. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- protocol Integer value for the protocol type (0 - 255). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- srcintf Source interface name from available interfaces. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest
- status Enable/disable the active status of this policy. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- comments Comment. type: str
more...
Supported Version Ranges:
v6.2.0 -> latest
- dst_addr6 (Alias name: dst-addr6) Ipv6 destination address. type: list or str
more...
Supported Version Ranges:
v6.4.0 -> latest
- nat_ippool6 (Alias name: nat-ippool6) Ipv6 pools to be used for source nat. type: list or str
more...
Supported Version Ranges:
v6.4.0 -> latest
- orig_addr6 (Alias name: orig-addr6) Ipv6 original address. type: list or str
more...
Supported Version Ranges:
v6.4.0 -> latest
- type Ipv4/ipv6 source nat. type: str choices: [ipv4, ipv6]
more...
Supported Version Ranges:
v6.4.0 -> latest
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str
more...
Supported Version Ranges:
v6.4.0 -> latest
- nat46 Enable/disable nat46. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.1 -> latest
- nat64 Enable/disable nat64. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.1 -> latest
- dst_port (Alias name: dst-port) Destination port or port range (1 to 65535, 0 means any port). type: str
more...
Supported Version Ranges:
v7.4.0 -> latest
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
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure central SNAT policies.
fortinet.fortimanager.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: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the central SNAT policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_firewall_centralsnatmap"
params:
adom: "ansible"
pkg: "ansible" # package name
central-snat-map: "your_value"
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 sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)