:source: fmgr_pkg_firewall_hyperscalepolicy.py
:orphan:
.. _fmgr_pkg_firewall_hyperscalepolicy:
fmgr_pkg_firewall_hyperscalepolicy -- Configure IPv4/IPv6 policies.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.2.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.
.. contents::
:local:
:depth: 1
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 v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
access_token -The token to access FortiManager without using username and password. type: strrequired: false
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: boolrequired: 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: strrequired: false
proposed_method - The overridden method for the underlying Json RPC request. type: strrequired: false choices: set, update, add
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: listrequired: false
rc_failed - The rc codes list with which the conditions to fail will be overriden. type: listrequired: false
state - The directive to create, update or delete an object type: strrequired: true choices: present, absent
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: strrequired: 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: integerrequired: falsedefault: 300
revision_note - The change note that can be specified when an object is created or updated. type: stringrequired: false
adom - The parameter in requested url type: strrequired: true
pkg - The parameter in requested url type: strrequired: true
dstaddr_negate(Alias name: dstaddr-negate) When enabled dstaddr/dstaddr6 specifies what the destination address must not be. type: strchoices: [disable, enable] more...
firewall_session_dirty(Alias name: firewall-session-dirty) How to handle sessions if the configuration of this firewall policy changes. type: strchoices: [check-all, check-new] more...
send_deny_packet(Alias name: send-deny-packet) Enable to send a reply when a session is denied or blocked by a firewall policy. type: strchoices: [disable, enable] more...
srcaddr_negate(Alias name: srcaddr-negate) When enabled srcaddr/srcaddr6 specifies what the source address must not be. type: strchoices: [disable, enable] 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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure IPv4/IPv6 policies.
fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy:
# workspace_locking_adom:
adom:
pkg:
state: present #
pkg_firewall_hyperscalepolicy:
policyid: 0 # Required variable, integer
# action:
# auto_asic_offload:
# cgn_eif:
# cgn_eim:
# cgn_log_server_grp:
# cgn_resource_quota:
# cgn_session_quota:
# comments:
# delay_tcp_npu_session:
# dstaddr:
# dstaddr_negate:
# dstaddr6:
# dstintf:
# firewall_session_dirty:
# global_label:
# ippool:
# label:
# name:
# nat:
# policy_offload:
# poolname:
# poolname6:
# send_deny_packet:
# service:
# service_negate:
# srcaddr:
# srcaddr_negate:
# srcaddr6:
# srcintf:
# status:
# tcp_timeout_pid:
# traffic_shaper:
# traffic_shaper_reverse:
# udp_timeout_pid:
# uuid:
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:
.. raw:: html
meta - The result of the request.returned: alwaystype: dict
request_url - The full url requested. returned: alwaystype: strsample: /sys/login/user
response_code - The status of api request. returned: alwaystype: intsample: 0
response_data - The data body of the api response. returned: optionaltype: list or dict
response_message - The descriptive message of the api response. returned: alwaystype: strsample: OK
system_information - The information of the target system. returned: alwaystype: dict
rc - The status the request. returned: alwaystype: intsample: 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 versiontype: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)