fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy module – Configure IPv4/IPv6 policies.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

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
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
pkg string / required	The parameter (pkg) in requested url.
pkg_firewall_hyperscalepolicy dictionary	The top level parameters set.
action string	Policy action Choices: `"deny"` `"accept"`
auto-asic-offload string	Deprecated, please rename it to auto_asic_offload. Enable/disable policy traffic ASIC offloading. Choices: `"disable"` `"enable"`
cgn-eif string	Deprecated, please rename it to cgn_eif. Enable/Disable CGN endpoint independent filtering. Choices: `"disable"` `"enable"`
cgn-eim string	Deprecated, please rename it to cgn_eim. Enable/Disable CGN endpoint independent mapping Choices: `"disable"` `"enable"`
cgn-log-server-grp string	Deprecated, please rename it to cgn_log_server_grp. NP log server group name
cgn-resource-quota integer	Deprecated, please rename it to cgn_resource_quota. Resource quota
cgn-session-quota integer	Deprecated, please rename it to cgn_session_quota. Session quota
comments string	Comment.
delay-tcp-npu-session string	Deprecated, please rename it to delay_tcp_npu_session. Enable TCP NPU session delay to guarantee packet order of 3-way han… Choices: `"disable"` `"enable"`
dstaddr any	(list or str) Destination IPv4 address and address group names.
dstaddr-negate string	Deprecated, please rename it to dstaddr_negate. When enabled dstaddr/dstaddr6 specifies what the destination address must … Choices: `"disable"` `"enable"`
dstaddr6 any	(list or str) Destination IPv6 address name and address group names.
dstintf any	(list or str) Outgoing
firewall-session-dirty string	Deprecated, please rename it to firewall_session_dirty. How to handle sessions if the configuration of this firewall polic… Choices: `"check-all"` `"check-new"`
global-label string	Deprecated, please rename it to global_label. Label for the policy that appears when the GUI is in Global View mode.
ippool string	Enable to use IP Pools for source NAT. Choices: `"disable"` `"enable"`
label string	Label for the policy that appears when the GUI is in Section View mode.
name string	Policy name.
nat string	Enable/disable source NAT. Choices: `"disable"` `"enable"`
policy-offload string	Deprecated, please rename it to policy_offload. Enable/Disable hardware session setup for CGNAT. Choices: `"disable"` `"enable"`
policyid integer / required	Policy ID
poolname any	(list or str) IP Pool names.
poolname6 any	(list or str) IPv6 pool names.
send-deny-packet string	Deprecated, please rename it to send_deny_packet. Enable to send a reply when a session is denied or blocked by a firewall… Choices: `"disable"` `"enable"`
service any	(list or str) Service and service group names.
service-negate string	Deprecated, please rename it to service_negate. When enabled service specifies what the service must NOT be. Choices: `"disable"` `"enable"`
srcaddr any	(list or str) Source IPv4 address and address group names.
srcaddr-negate string	Deprecated, please rename it to srcaddr_negate. When enabled srcaddr/srcaddr6 specifies what the source address must NOT be. Choices: `"disable"` `"enable"`
srcaddr6 any	(list or str) Source IPv6 address name and address group names.
srcintf any	(list or str) Incoming
status string	Enable or disable this policy. Choices: `"disable"` `"enable"`
tcp-timeout-pid string	Deprecated, please rename it to tcp_timeout_pid. TCP timeout profile ID
traffic-shaper string	Deprecated, please rename it to traffic_shaper. Traffic shaper.
traffic-shaper-reverse string	Deprecated, please rename it to traffic_shaper_reverse. Reverse traffic shaper.
udp-timeout-pid string	Deprecated, please rename it to udp_timeout_pid. UDP timeout profile ID
uuid string	Universally Unique Identifier
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: `"present"` `"absent"`
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`

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
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy module – Configure IPv4/IPv6 policies.

Synopsis

Parameters

Notes

Examples

Return Values