fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy module – Configure IPv4/IPv6 policies.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
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.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy.
New in fortinet.fortimanager 2.2.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (pkg) in requested url. |
|
The top level parameters set. |
|
Policy action Choices:
|
|
Enable/disable policy traffic ASIC offloading. Choices:
|
|
Enable/Disable CGN endpoint independent filtering. Choices:
|
|
Enable/Disable CGN endpoint independent mapping Choices:
|
|
NP log server group name |
|
Resource quota |
|
Session quota |
|
Comment. |
|
Enable TCP NPU session delay to guarantee packet order of 3-way handshake. Choices:
|
|
(list or str) Destination IPv4 address and address group names. |
|
(list or str) Destination IPv6 address name and address group names. |
|
When enabled dstaddr/dstaddr6 specifies what the destination address must NOT be. Choices:
|
|
(list or str) Outgoing |
|
How to handle sessions if the configuration of this firewall policy changes. Choices:
|
|
Label for the policy that appears when the GUI is in Global View mode. |
|
Enable to use IP Pools for source NAT. Choices:
|
|
Label for the policy that appears when the GUI is in Section View mode. |
|
Policy name. |
|
Enable/disable source NAT. Choices:
|
|
Enable/Disable hardware session setup for CGNAT. Choices:
|
|
Policy ID |
|
(list or str) IP Pool names. |
|
(list or str) IPv6 pool names. |
|
Enable to send a reply when a session is denied or blocked by a firewall policy. Choices:
|
|
(list or str) Service and service group names. |
|
When enabled service specifies what the service must NOT be. Choices:
|
|
(list or str) Source IPv4 address and address group names. |
|
(list or str) Source IPv6 address name and address group names. |
|
When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. Choices:
|
|
(list or str) Incoming |
|
Enable or disable this policy. Choices:
|
|
TCP timeout profile ID |
|
Traffic shaper. |
|
Reverse traffic shaper. |
|
UDP timeout profile ID |
|
Universally Unique Identifier |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4/IPv6 policies.
fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
pkg: <your own value>
state: present # <value in [present, absent]>
pkg_firewall_hyperscalepolicy:
action: <value in [deny, accept]>
auto_asic_offload: <value in [disable, enable]>
cgn_eif: <value in [disable, enable]>
cgn_eim: <value in [disable, enable]>
cgn_log_server_grp: <string>
cgn_resource_quota: <integer>
cgn_session_quota: <integer>
comments: <string>
delay_tcp_npu_session: <value in [disable, enable]>
dstaddr: <list or string>
dstaddr_negate: <value in [disable, enable]>
dstaddr6: <list or string>
dstintf: <list or string>
firewall_session_dirty: <value in [check-all, check-new]>
global_label: <string>
ippool: <value in [disable, enable]>
label: <string>
name: <string>
nat: <value in [disable, enable]>
policy_offload: <value in [disable, enable]>
policyid: <integer>
poolname: <list or string>
poolname6: <list or string>
send_deny_packet: <value in [disable, enable]>
service: <list or string>
service_negate: <value in [disable, enable]>
srcaddr: <list or string>
srcaddr_negate: <value in [disable, enable]>
srcaddr6: <list or string>
srcintf: <list or string>
status: <value in [disable, enable]>
tcp_timeout_pid: <string>
traffic_shaper: <string>
traffic_shaper_reverse: <string>
udp_timeout_pid: <string>
uuid: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |