Try SpotterConfigure IPv4/IPv6 policies.
| "added in version" 2.0.0 of drmofu.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 drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- hosts: fortimanager00
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 header policies.
fmgr_pkg_header_policy:
bypass_validation: False
pkg: ansible
state: present
pkg_header_policy:
action: accept #<value in [deny, accept, ipsec, ...]>
comments: 'ansible-comment'
dstaddr: gall
dstintf: any
name: ansible-test-header
policyid: 1073741826 # must larger than 2^30(1074741824), since header/footer policy is a special policy
schedule: galways
service: gALL
srcaddr: gall
srcintf: any
status: disable
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the IPv4 header policies
fmgr_fact:
facts:
selector: 'pkg_header_policy'
params:
pkg: 'ansible'
policy: 'your_value'
pkg:
description: the parameter (pkg) 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
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
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.
required: false
type: bool
pkg_header_policy:
description: the top level parameters set
required: false
suboptions:
_policy_block:
description: Assigned policy block.
type: int
access-proxy:
description: description
type: str
action:
choices:
- deny
- accept
- ipsec
- ssl-vpn
- redirect
- isolate
description: no description
type: str
active-auth-method:
choices:
- ntlm
- basic
- digest
- form
description: no description
type: str
anti-replay:
choices:
- disable
- enable
description: no description
type: str
app-category:
description: no description
type: str
app-group:
description: no description
type: str
application:
description: description
type: int
application-charts:
choices:
- top10-app
- top10-p2p-user
- top10-media-user
description: description
elements: str
type: list
application-list:
description: no description
type: str
auth-cert:
description: no description
type: str
auth-method:
choices:
- basic
- digest
- ntlm
- fsae
- form
- fsso
- rsso
description: no description
type: str
auth-path:
choices:
- disable
- enable
description: no description
type: str
auth-portal:
choices:
- disable
- enable
description: no description
type: str
auth-redirect-addr:
description: no description
type: str
auto-asic-offload:
choices:
- disable
- enable
description: no description
type: str
av-profile:
description: no description
type: str
bandwidth:
choices:
- disable
- enable
description: no description
type: str
best-route:
choices:
- disable
- enable
description: no description
type: str
block-notification:
choices:
- disable
- enable
description: no description
type: str
captive-portal-exempt:
choices:
- disable
- enable
description: no description
type: str
capture-packet:
choices:
- disable
- enable
description: no description
type: str
casi-profile:
description: no description
type: str
central-nat:
choices:
- disable
- enable
description: no description
type: str
cgn-eif:
choices:
- disable
- enable
description: Enable/Disable CGN endpoint independent filtering.
type: str
cgn-eim:
choices:
- disable
- enable
description: Enable/Disable CGN endpoint independent mapping
type: str
cgn-log-server-grp:
description: NP log server group name
type: str
cgn-resource-quota:
description: resource quota
type: int
cgn-session-quota:
description: session quota
type: int
cifs-profile:
description: no description
type: str
client-reputation:
choices:
- disable
- enable
description: no description
type: str
client-reputation-mode:
choices:
- learning
- monitoring
description: no description
type: str
comments:
description: no description
type: str
custom-log-fields:
description: no description
type: str
decrypted-traffic-mirror:
description: no description
type: str
deep-inspection-options:
description: no description
type: str
delay-tcp-npu-session:
choices:
- disable
- enable
description: no description
type: str
delay-tcp-npu-sessoin:
choices:
- disable
- enable
description: no description
type: str
device-detection-portal:
choices:
- disable
- enable
description: no description
type: str
device-ownership:
choices:
- disable
- enable
description: no description
type: str
devices:
description: no description
type: str
diffserv-copy:
choices:
- disable
- enable
description: Enable to copy packets DiffServ values from sessions original direction
to its reply direction.
type: str
diffserv-forward:
choices:
- disable
- enable
description: no description
type: str
diffserv-reverse:
choices:
- disable
- enable
description: no description
type: str
diffservcode-forward:
description: no description
type: str
diffservcode-rev:
description: no description
type: str
disclaimer:
choices:
- disable
- enable
- user
- domain
- policy
description: no description
type: str
dlp-profile:
description: Name of an existing DLP profile.
type: str
dlp-sensor:
description: no description
type: str
dnsfilter-profile:
description: no description
type: str
dponly:
choices:
- disable
- enable
description: no description
type: str
dscp-match:
choices:
- disable
- enable
description: no description
type: str
dscp-negate:
choices:
- disable
- enable
description: no description
type: str
dscp-value:
description: no description
type: str
dsri:
choices:
- disable
- enable
description: no description
type: str
dstaddr:
description: no description
type: str
dstaddr-negate:
choices:
- disable
- enable
description: no description
type: str
dstaddr6:
description: no description
type: str
dstaddr6-negate:
choices:
- disable
- enable
description: When enabled dstaddr6 specifies what the destination address must
NOT be.
type: str
dstintf:
description: no description
type: str
dynamic-bypass:
choices:
- disable
- enable
description: no description
type: str
dynamic-profile:
choices:
- disable
- enable
description: no description
type: str
dynamic-profile-access:
choices:
- imap
- smtp
- pop3
- http
- ftp
- im
- nntp
- imaps
- smtps
- pop3s
- https
- ftps
- ssh
description: description
elements: str
type: list
dynamic-profile-fallthrough:
choices:
- disable
- enable
description: no description
type: str
dynamic-profile-group:
description: no description
type: str
dynamic-shaping:
choices:
- disable
- enable
description: Enable/disable dynamic RADIUS defined traffic shaping.
type: str
email-collect:
choices:
- disable
- enable
description: no description
type: str
email-collection-portal:
choices:
- disable
- enable
description: no description
type: str
emailfilter-profile:
description: no description
type: str
endpoint-check:
choices:
- disable
- enable
description: no description
type: str
endpoint-compliance:
choices:
- disable
- enable
description: no description
type: str
endpoint-keepalive-interface:
description: no description
type: str
endpoint-profile:
description: no description
type: str
failed-connection:
choices:
- disable
- enable
description: no description
type: str
fall-through-unauthenticated:
choices:
- disable
- enable
description: no description
type: str
fec:
choices:
- disable
- enable
description: Enable/disable Forward Error Correction on traffic matching this
policy on a FEC device.
type: str
file-filter-profile:
description: no description
type: str
firewall-session-dirty:
choices:
- check-all
- check-new
description: no description
type: str
fixedport:
choices:
- disable
- enable
description: no description
type: str
force-proxy:
choices:
- disable
- enable
description: no description
type: str
forticlient-compliance-devices:
choices:
- windows-pc
- mac
- iphone-ipad
- android
description: description
elements: str
type: list
forticlient-compliance-enforcement-portal:
choices:
- disable
- enable
description: no description
type: str
fsae:
choices:
- disable
- enable
description: no description
type: str
fsae-server-for-ntlm:
description: no description
type: str
fsso:
choices:
- disable
- enable
description: no description
type: str
fsso-agent-for-ntlm:
description: no description
type: str
fsso-groups:
description: no description
type: str
geo-location:
choices:
- disable
- enable
description: no description
type: str
geoip-anycast:
choices:
- disable
- enable
description: no description
type: str
geoip-match:
choices:
- physical-location
- registered-location
description: no description
type: str
global-label:
description: no description
type: str
groups:
description: no description
type: str
gtp-profile:
description: no description
type: str
http-policy-redirect:
choices:
- disable
- enable
description: no description
type: str
http-tunnel-auth:
choices:
- disable
- enable
description: no description
type: str
ia-profile:
description: description
type: str
icap-profile:
description: no description
type: str
identity-based:
choices:
- disable
- enable
description: no description
type: str
identity-based-policy:
description: description
elements: dict
suboptions:
action:
choices:
- deny
- accept
description: no description
type: str
application-charts:
choices:
- top10-app
- top10-p2p-user
- top10-media-user
description: description
elements: str
type: list
application-list:
description: no description
type: str
av-profile:
description: no description
type: str
capture-packet:
choices:
- disable
- enable
description: no description
type: str
deep-inspection-options:
description: no description
type: str
devices:
description: no description
type: str
dlp-sensor:
description: no description
type: str
dstaddr:
description: no description
type: str
dstaddr-negate:
choices:
- disable
- enable
description: no description
type: str
endpoint-compliance:
choices:
- disable
- enable
description: no description
type: str
groups:
description: no description
type: str
icap-profile:
description: no description
type: str
id:
description: no description
type: int
ips-sensor:
description: no description
type: str
logtraffic:
choices:
- disable
- enable
- all
- utm
description: no description
type: str
logtraffic-app:
choices:
- disable
- enable
description: no description
type: str
logtraffic-start:
choices:
- disable
- enable
description: no description
type: str
mms-profile:
description: no description
type: str
per-ip-shaper:
description: no description
type: str
profile-group:
description: no description
type: str
profile-protocol-options:
description: no description
type: str
profile-type:
choices:
- single
- group
description: no description
type: str
replacemsg-group:
description: no description
type: str
schedule:
description: no description
type: str
send-deny-packet:
choices:
- disable
- enable
description: no description
type: str
service:
description: no description
type: str
service-negate:
choices:
- disable
- enable
description: no description
type: str
spamfilter-profile:
description: no description
type: str
sslvpn-portal:
description: no description
type: str
sslvpn-realm:
description: no description
type: str
traffic-shaper:
description: no description
type: str
traffic-shaper-reverse:
description: no description
type: str
users:
description: no description
type: str
utm-status:
choices:
- disable
- enable
description: no description
type: str
voip-profile:
description: no description
type: str
webfilter-profile:
description: no description
type: str
type: list
identity-based-route:
description: no description
type: str
identity-from:
choices:
- auth
- device
description: no description
type: str
inbound:
choices:
- disable
- enable
description: no description
type: str
inspection-mode:
choices:
- proxy
- flow
description: no description
type: str
internet-service:
choices:
- disable
- enable
description: no description
type: str
internet-service-custom:
description: no description
type: str
internet-service-custom-group:
description: no description
type: str
internet-service-group:
description: no description
type: str
internet-service-id:
description: no description
type: str
internet-service-name:
description: no description
type: str
internet-service-negate:
choices:
- disable
- enable
description: no description
type: str
internet-service-src:
choices:
- disable
- enable
description: no description
type: str
internet-service-src-custom:
description: no description
type: str
internet-service-src-custom-group:
description: no description
type: str
internet-service-src-group:
description: no description
type: str
internet-service-src-id:
description: no description
type: str
internet-service-src-name:
description: no description
type: str
internet-service-src-negate:
choices:
- disable
- enable
description: no description
type: str
internet-service6:
choices:
- disable
- enable
description: Enable/disable use of IPv6 Internet Services for this policy.
type: str
internet-service6-custom:
description: description
type: str
internet-service6-custom-group:
description: description
type: str
internet-service6-group:
description: description
type: str
internet-service6-name:
description: description
type: str
internet-service6-negate:
choices:
- disable
- enable
description: When enabled internet-service6 specifies what the service must NOT
be.
type: str
internet-service6-src:
choices:
- disable
- enable
description: Enable/disable use of IPv6 Internet Services in source for this policy.
type: str
internet-service6-src-custom:
description: description
type: str
internet-service6-src-custom-group:
description: description
type: str
internet-service6-src-group:
description: description
type: str
internet-service6-src-name:
description: description
type: str
internet-service6-src-negate:
choices:
- disable
- enable
description: When enabled internet-service6-src specifies what the service must
NOT be.
type: str
ip-based:
choices:
- disable
- enable
description: no description
type: str
ip-version-type:
description: IP version of the policy.
type: str
ippool:
choices:
- disable
- enable
description: no description
type: str
ips-sensor:
description: no description
type: str
ips-voip-filter:
description: Name of an existing VoIP
type: str
isolator-profile:
description: description
type: str
isolator-server:
description: description
type: str
label:
description: no description
type: str
learning-mode:
choices:
- disable
- enable
description: no description
type: str
log-http-transaction:
choices:
- disable
- enable
description: no description
type: str
log-unmatched-traffic:
choices:
- disable
- enable
description: no description
type: str
logtraffic:
choices:
- disable
- enable
- all
- utm
description: no description
type: str
logtraffic-app:
choices:
- disable
- enable
description: no description
type: str
logtraffic-start:
choices:
- disable
- enable
description: no description
type: str
match-vip:
choices:
- disable
- enable
description: no description
type: str
match-vip-only:
choices:
- disable
- enable
description: no description
type: str
max-session-per-user:
description: no description
type: int
mms-profile:
description: no description
type: str
name:
description: no description
type: str
nat:
choices:
- disable
- enable
description: no description
type: str
nat46:
choices:
- disable
- enable
description: Enable/disable NAT46.
type: str
nat64:
choices:
- disable
- enable
description: Enable/disable NAT64.
type: str
natinbound:
choices:
- disable
- enable
description: no description
type: str
natip:
description: no description
type: str
natoutbound:
choices:
- disable
- enable
description: no description
type: str
network-service-dynamic:
description: description
type: str
network-service-src-dynamic:
description: description
type: str
np-accelation:
choices:
- disable
- enable
description: no description
type: str
np-acceleration:
choices:
- disable
- enable
description: no description
type: str
ntlm:
choices:
- disable
- enable
description: no description
type: str
ntlm-enabled-browsers:
description: description
type: str
ntlm-guest:
choices:
- disable
- enable
description: no description
type: str
outbound:
choices:
- disable
- enable
description: no description
type: str
pass-through:
choices:
- disable
- enable
description: no description
type: str
passive-wan-health-measurement:
choices:
- disable
- enable
description: Enable/disable passive WAN health measurement.
type: str
pcp-inbound:
choices:
- disable
- enable
description: Enable/disable PCP inbound DNAT.
type: str
pcp-outbound:
choices:
- disable
- enable
description: Enable/disable PCP outbound SNAT.
type: str
pcp-poolname:
description: description
type: str
per-ip-shaper:
description: no description
type: str
permit-any-host:
choices:
- disable
- enable
description: no description
type: str
permit-stun-host:
choices:
- disable
- enable
description: no description
type: str
pfcp-profile:
description: PFCP profile.
type: str
policy-behaviour-type:
description: Behaviour of the policy.
type: str
policy-expiry:
choices:
- disable
- enable
description: Enable/disable policy expiry.
type: str
policy-expiry-date:
description: Policy expiry date
type: str
policy-expiry-date-utc:
description: Policy expiry date and time, in epoch format.
type: str
policy-offload:
choices:
- disable
- enable
description: Enable/Disable hardware session setup for CGNAT.
type: str
policyid:
description: no description
type: int
poolname:
description: no description
type: str
poolname6:
description: no description
type: str
profile-group:
description: no description
type: str
profile-protocol-options:
description: no description
type: str
profile-type:
choices:
- single
- group
description: no description
type: str
radius-mac-auth-bypass:
choices:
- disable
- enable
description: no description
type: str
redirect-url:
description: no description
type: str
replacemsg-group:
description: no description
type: str
replacemsg-override-group:
description: no description
type: str
reputation-direction:
choices:
- source
- destination
description: no description
type: str
reputation-direction6:
choices:
- source
- destination
description: Direction of the initial traffic for IPv6 reputation to take effect.
type: str
reputation-minimum:
description: no description
type: int
reputation-minimum6:
description: IPv6 Minimum Reputation to take action.
type: int
require-tfa:
choices:
- disable
- enable
description: no description
type: str
reverse-cache:
choices:
- disable
- enable
description: no description
type: str
rsso:
choices:
- disable
- enable
description: no description
type: str
rtp-addr:
description: no description
type: str
rtp-nat:
choices:
- disable
- enable
description: no description
type: str
scan-botnet-connections:
choices:
- disable
- block
- monitor
description: no description
type: str
schedule:
description: no description
type: str
schedule-timeout:
choices:
- disable
- enable
description: no description
type: str
sctp-filter-profile:
description: Name of an existing SCTP filter profile.
type: str
send-deny-packet:
choices:
- disable
- enable
description: no description
type: str
service:
description: no description
type: str
service-negate:
choices:
- disable
- enable
description: no description
type: str
session-ttl:
description: no description
type: int
sessions:
choices:
- disable
- enable
description: no description
type: str
sgt:
description: description
type: int
sgt-check:
choices:
- disable
- enable
description: Enable/disable security group tags
type: str
spamfilter-profile:
description: no description
type: str
src-vendor-mac:
description: no description
type: str
srcaddr:
description: no description
type: str
srcaddr-negate:
choices:
- disable
- enable
description: no description
type: str
srcaddr6:
description: no description
type: str
srcaddr6-negate:
choices:
- disable
- enable
description: When enabled srcaddr6 specifies what the source address must NOT
be.
type: str
srcintf:
description: no description
type: str
ssh-filter-profile:
description: no description
type: str
ssh-policy-check:
choices:
- disable
- enable
description: no description
type: str
ssh-policy-redirect:
choices:
- disable
- enable
description: no description
type: str
ssl-mirror:
choices:
- disable
- enable
description: no description
type: str
ssl-mirror-intf:
description: no description
type: str
ssl-ssh-profile:
description: no description
type: str
sslvpn-auth:
choices:
- any
- local
- radius
- ldap
- tacacs+
description: no description
type: str
sslvpn-ccert:
choices:
- disable
- enable
description: no description
type: str
sslvpn-cipher:
choices:
- any
- high
- medium
description: no description
type: str
sso-auth-method:
choices:
- fsso
- rsso
description: no description
type: str
status:
choices:
- disable
- enable
description: no description
type: str
tags:
description: no description
type: str
tcp-mss-receiver:
description: no description
type: int
tcp-mss-sender:
description: no description
type: int
tcp-reset:
choices:
- disable
- enable
description: no description
type: str
tcp-session-without-syn:
choices:
- all
- data-only
- disable
description: no description
type: str
tcp-timeout-pid:
description: description
type: str
timeout-send-rst:
choices:
- disable
- enable
description: no description
type: str
tos:
description: no description
type: str
tos-mask:
description: no description
type: str
tos-negate:
choices:
- disable
- enable
description: no description
type: str
traffic-shaper:
description: no description
type: str
traffic-shaper-reverse:
description: no description
type: str
transaction-based:
choices:
- disable
- enable
description: no description
type: str
transparent:
choices:
- disable
- enable
description: no description
type: str
type:
choices:
- explicit-web
- transparent
- explicit-ftp
- ssh-tunnel
- ssh
- wanopt
- access-proxy
description: no description
type: str
udp-timeout-pid:
description: description
type: str
url-category:
description: no description
type: str
users:
description: no description
type: str
utm-inspection-mode:
choices:
- proxy
- flow
description: no description
type: str
utm-status:
choices:
- disable
- enable
description: no description
type: str
uuid:
description: no description
type: str
uuid-idx:
description: no description
type: int
vendor-mac:
description: no description
type: str
videofilter-profile:
description: Name of an existing VideoFilter profile.
type: str
vlan-cos-fwd:
description: no description
type: int
vlan-cos-rev:
description: no description
type: int
vlan-filter:
description: no description
type: str
voip-profile:
description: no description
type: str
vpntunnel:
description: no description
type: str
waf-profile:
description: no description
type: str
wanopt:
choices:
- disable
- enable
description: no description
type: str
wanopt-detection:
choices:
- active
- passive
- 'off'
description: no description
type: str
wanopt-passive-opt:
choices:
- default
- transparent
- non-transparent
description: no description
type: str
wanopt-peer:
description: no description
type: str
wanopt-profile:
description: no description
type: str
wccp:
choices:
- disable
- enable
description: no description
type: str
web-auth-cookie:
choices:
- disable
- enable
description: no description
type: str
webcache:
choices:
- disable
- enable
description: no description
type: str
webcache-https:
choices:
- disable
- ssl-server
- any
- enable
description: no description
type: str
webfilter-profile:
description: no description
type: str
webproxy-forward-server:
description: no description
type: str
webproxy-profile:
description: no description
type: str
wsso:
choices:
- disable
- enable
description: no description
type: str
ztna-device-ownership:
choices:
- disable
- enable
description: Enable/disable zero trust device ownership.
type: str
ztna-ems-tag:
description: Source ztna-ems-tag names.
type: str
ztna-ems-tag-secondary:
description: description
type: str
ztna-geo-tag:
description: Source ztna-geo-tag names.
type: str
ztna-policy-redirect:
choices:
- disable
- enable
description: Redirect ZTNA traffic to matching Access-Proxy proxy-policy.
type: str
ztna-status:
choices:
- disable
- enable
description: Enable/disable zero trust access.
type: str
ztna-tags-match-logic:
choices:
- or
- and
description: no description
type: str
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
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