Try SpotterConfigure IPv4/IPv6 policies.
| "added in version" 2.2.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
pkg:
description: The parameter (pkg) in requested url.
required: true
type: str
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
pkg_firewall_hyperscalepolicy:
description: The top level parameters set.
required: false
suboptions:
action:
choices:
- deny
- accept
description: Policy action
type: str
auto-asic-offload:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_asic_offload. Enable/disable
policy traffic ASIC offloading.
type: str
cgn-eif:
choices:
- disable
- enable
description: Deprecated, please rename it to cgn_eif. Enable/Disable CGN endpoint
independent filtering.
type: str
cgn-eim:
choices:
- disable
- enable
description: Deprecated, please rename it to cgn_eim. Enable/Disable CGN endpoint
independent mapping
type: str
cgn-log-server-grp:
description: Deprecated, please rename it to cgn_log_server_grp. NP log server
group name
type: str
cgn-resource-quota:
description: Deprecated, please rename it to cgn_resource_quota. Resource quota
type: int
cgn-session-quota:
description: Deprecated, please rename it to cgn_session_quota. Session quota
type: int
comments:
description: Comment.
type: str
delay-tcp-npu-session:
choices:
- disable
- enable
description: Deprecated, please rename it to delay_tcp_npu_session. Enable TCP
NPU session delay to guarantee packet order of 3-way han...
type: str
dstaddr:
description: (list or str) No description.
type: raw
dstaddr-negate:
choices:
- disable
- enable
description: Deprecated, please rename it to dstaddr_negate. When enabled dstaddr/dstaddr6
specifies what the destination address must ...
type: str
dstaddr6:
description: (list or str) No description.
type: raw
dstintf:
description: (list or str) No description.
type: raw
firewall-session-dirty:
choices:
- check-all
- check-new
description: Deprecated, please rename it to firewall_session_dirty. How to handle
sessions if the configuration of this firewall polic...
type: str
global-label:
description: Deprecated, please rename it to global_label. Label for the policy
that appears when the GUI is in Global View mode.
type: str
ippool:
choices:
- disable
- enable
description: Enable to use IP Pools for source NAT.
type: str
label:
description: Label for the policy that appears when the GUI is in Section View
mode.
type: str
name:
description: Policy name.
type: str
nat:
choices:
- disable
- enable
description: Enable/disable source NAT.
type: str
policy-offload:
choices:
- disable
- enable
description: Deprecated, please rename it to policy_offload. Enable/Disable hardware
session setup for CGNAT.
type: str
policyid:
description: Policy ID
required: true
type: int
poolname:
description: (list or str) No description.
type: raw
poolname6:
description: (list or str) No description.
type: raw
send-deny-packet:
choices:
- disable
- enable
description: Deprecated, please rename it to send_deny_packet. Enable to send
a reply when a session is denied or blocked by a firewall...
type: str
service:
description: (list or str) No description.
type: raw
service-negate:
choices:
- disable
- enable
description: Deprecated, please rename it to service_negate. When enabled service
specifies what the service must NOT be.
type: str
srcaddr:
description: (list or str) No description.
type: raw
srcaddr-negate:
choices:
- disable
- enable
description: Deprecated, please rename it to srcaddr_negate. When enabled srcaddr/srcaddr6
specifies what the source address must NOT be.
type: str
srcaddr6:
description: (list or str) No description.
type: raw
srcintf:
description: (list or str) No description.
type: raw
status:
choices:
- disable
- enable
description: Enable or disable this policy.
type: str
tcp-timeout-pid:
description: Deprecated, please rename it to tcp_timeout_pid. TCP timeout profile
ID
type: str
traffic-shaper:
description: Deprecated, please rename it to traffic_shaper. Traffic shaper.
type: str
traffic-shaper-reverse:
description: Deprecated, please rename it to traffic_shaper_reverse. Reverse traffic
shaper.
type: str
udp-timeout-pid:
description: Deprecated, please rename it to udp_timeout_pid. UDP timeout profile
ID
type: str
uuid:
description: Universally Unique Identifier
type: str
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list