Try SpotterConfigure FortiGuard services.
| "added in version" 2.0.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 FortiGuard services.
fortinet.fortimanager.fmgr_system_fortiguard:
# 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>
system_fortiguard:
antispam_cache: <value in [disable, enable]>
antispam_cache_mpercent: <integer>
antispam_cache_ttl: <integer>
antispam_expiration: <integer>
antispam_force_off: <value in [disable, enable]>
antispam_license: <integer>
antispam_timeout: <integer>
auto_join_forticloud: <value in [disable, enable]>
ddns_server_ip: <string>
ddns_server_port: <integer>
load_balance_servers: <integer>
outbreak_prevention_cache: <value in [disable, enable]>
outbreak_prevention_cache_mpercent: <integer>
outbreak_prevention_cache_ttl: <integer>
outbreak_prevention_expiration: <integer>
outbreak_prevention_force_off: <value in [disable, enable]>
outbreak_prevention_license: <integer>
outbreak_prevention_timeout: <integer>
port: <value in [53, 80, 8888, ...]>
sdns_server_ip: <list or string>
sdns_server_port: <integer>
service_account_id: <string>
source_ip: <string>
source_ip6: <string>
update_server_location: <value in [any, usa, automatic, ...]>
webfilter_cache: <value in [disable, enable]>
webfilter_cache_ttl: <integer>
webfilter_expiration: <integer>
webfilter_force_off: <value in [disable, enable]>
webfilter_license: <integer>
webfilter_timeout: <integer>
protocol: <value in [udp, http, https]>
proxy_password: <list or string>
proxy_server_ip: <string>
proxy_server_port: <integer>
proxy_username: <string>
sandbox_region: <string>
avquery_cache_ttl: <integer>
avquery_timeout: <integer>
avquery_cache: <value in [disable, enable]>
avquery_cache_mpercent: <integer>
avquery_license: <integer>
avquery_force_off: <value in [disable, enable]>
fortiguard_anycast: <value in [disable, enable]>
fortiguard_anycast_source: <value in [fortinet, aws, debug]>
interface: <string>
interface_select_method: <value in [auto, sdwan, specify]>
sdns_options:
- include-question-section
anycast_sdns_server_ip: <string>
anycast_sdns_server_port: <integer>
persistent_connection: <value in [disable, enable]>
update_build_proxy: <value in [disable, enable]>
update_extdb: <value in [disable, enable]>
update_ffdb: <value in [disable, enable]>
update_uwdb: <value in [disable, enable]>
videofilter_expiration: <integer>
videofilter_license: <integer>
ddns_server_ip6: <string>
vdom: <string>
auto_firmware_upgrade: <value in [disable, enable]>
auto_firmware_upgrade_day:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
auto_firmware_upgrade_end_hour: <integer>
auto_firmware_upgrade_start_hour: <integer>
sandbox_inline_scan: <value in [disable, enable]>
auto_firmware_upgrade_delay: <integer>
gui_prompt_auto_upgrade: <value in [disable, enable]>
FDS_license_expiring_days: <integer>
antispam_cache_mpermille: <integer>
outbreak_prevention_cache_mpermille: <integer>
update_dldb: <value in [disable, enable]>
adom:
description: The parameter (adom) in requested url.
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
system_fortiguard:
description: The top level parameters set.
required: false
suboptions:
FDS-license-expiring-days:
description: Deprecated, please rename it to FDS_license_expiring_days. Threshold
for number of days before FortiGuard license expirati...
type: int
antispam-cache:
choices:
- disable
- enable
description: Deprecated, please rename it to antispam_cache. Enable/disable FortiGuard
antispam request caching.
type: str
antispam-cache-mpercent:
description: Deprecated, please rename it to antispam_cache_mpercent. Maximum
percent of FortiGate memory the antispam cache is allowed...
type: int
antispam-cache-mpermille:
description: Deprecated, please rename it to antispam_cache_mpermille. Maximum
permille of FortiGate memory the antispam cache is allow...
type: int
antispam-cache-ttl:
description: Deprecated, please rename it to antispam_cache_ttl. Time-to-live
for antispam cache entries in seconds
type: int
antispam-expiration:
description: Deprecated, please rename it to antispam_expiration. Antispam-Expiration.
type: int
antispam-force-off:
choices:
- disable
- enable
description: Deprecated, please rename it to antispam_force_off. Enable/disable
turning off the FortiGuard antispam service.
type: str
antispam-license:
description: Deprecated, please rename it to antispam_license. Antispam-License.
type: int
antispam-timeout:
description: Deprecated, please rename it to antispam_timeout. Antispam query
time out
type: int
anycast-sdns-server-ip:
description: Deprecated, please rename it to anycast_sdns_server_ip. IP address
of the FortiGuard anycast DNS rating server.
type: str
anycast-sdns-server-port:
description: Deprecated, please rename it to anycast_sdns_server_port. Port to
connect to on the FortiGuard anycast DNS rating server.
type: int
auto-firmware-upgrade:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_firmware_upgrade. Enable/disable
automatic patch-level firmware upgrade from FortiGuard.
type: str
auto-firmware-upgrade-day:
choices:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
description: Deprecated, please rename it to auto_firmware_upgrade_day.
elements: str
type: list
auto-firmware-upgrade-delay:
description: Deprecated, please rename it to auto_firmware_upgrade_delay. Delay
of day
type: int
auto-firmware-upgrade-end-hour:
description: Deprecated, please rename it to auto_firmware_upgrade_end_hour. End
time in the designated time window for automatic patch...
type: int
auto-firmware-upgrade-start-hour:
description: Deprecated, please rename it to auto_firmware_upgrade_start_hour.
Start time in the designated time window for automatic p...
type: int
auto-join-forticloud:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_join_forticloud. Automatically
connect to and login to FortiCloud.
type: str
avquery-cache:
choices:
- disable
- enable
description: Deprecated, please rename it to avquery_cache. Enable/disable the
FortiGuard antivirus cache.
type: str
avquery-cache-mpercent:
description: Deprecated, please rename it to avquery_cache_mpercent. Maximum percent
of memory the antivirus cache can use
type: int
avquery-cache-ttl:
description: Deprecated, please rename it to avquery_cache_ttl. Time-to-live for
antivirus cache entries
type: int
avquery-force-off:
choices:
- disable
- enable
description: Deprecated, please rename it to avquery_force_off. Turn off the FortiGuard
antivirus service.
type: str
avquery-license:
description: Deprecated, please rename it to avquery_license. Interval of time
between license checks for the FortiGuard antivirus cont...
type: int
avquery-timeout:
description: Deprecated, please rename it to avquery_timeout. Antivirus query
time out
type: int
ddns-server-ip:
description: Deprecated, please rename it to ddns_server_ip. IP address of the
FortiDDNS server.
type: str
ddns-server-ip6:
description: Deprecated, please rename it to ddns_server_ip6. IPv6 address of
the FortiDDNS server.
type: str
ddns-server-port:
description: Deprecated, please rename it to ddns_server_port. Port used to communicate
with FortiDDNS servers.
type: int
fortiguard-anycast:
choices:
- disable
- enable
description: Deprecated, please rename it to fortiguard_anycast. Enable/disable
use of FortiGuards anycast network.
type: str
fortiguard-anycast-source:
choices:
- fortinet
- aws
- debug
description: Deprecated, please rename it to fortiguard_anycast_source. Configure
which of Fortinets servers to provide FortiGuard serv...
type: str
gui-prompt-auto-upgrade:
choices:
- disable
- enable
description: Deprecated, please rename it to gui_prompt_auto_upgrade. Enable/disable
prompting of automatic patch-level firmware upgrad...
type: str
interface:
description: Specify outgoing interface to reach server.
type: str
interface-select-method:
choices:
- auto
- sdwan
- specify
description: Deprecated, please rename it to interface_select_method. Specify
how to select outgoing interface to reach server.
type: str
load-balance-servers:
description: Deprecated, please rename it to load_balance_servers. Number of servers
to alternate between as first FortiGuard option.
type: int
outbreak-prevention-cache:
choices:
- disable
- enable
description: Deprecated, please rename it to outbreak_prevention_cache. Enable/disable
FortiGuard Virus Outbreak Prevention cache.
type: str
outbreak-prevention-cache-mpercent:
description: Deprecated, please rename it to outbreak_prevention_cache_mpercent.
Maximum percent of memory FortiGuard Virus Outbreak Pr...
type: int
outbreak-prevention-cache-mpermille:
description: Deprecated, please rename it to outbreak_prevention_cache_mpermille.
Maximum permille of memory FortiGuard Virus Outbreak ...
type: int
outbreak-prevention-cache-ttl:
description: Deprecated, please rename it to outbreak_prevention_cache_ttl. Time-to-live
for FortiGuard Virus Outbreak Prevention cache...
type: int
outbreak-prevention-expiration:
description: Deprecated, please rename it to outbreak_prevention_expiration. Outbreak-Prevention-Expiration.
type: int
outbreak-prevention-force-off:
choices:
- disable
- enable
description: Deprecated, please rename it to outbreak_prevention_force_off. Turn
off FortiGuard Virus Outbreak Prevention service.
type: str
outbreak-prevention-license:
description: Deprecated, please rename it to outbreak_prevention_license. Outbreak-Prevention-License.
type: int
outbreak-prevention-timeout:
description: Deprecated, please rename it to outbreak_prevention_timeout. FortiGuard
Virus Outbreak Prevention time out
type: int
persistent-connection:
choices:
- disable
- enable
description: Deprecated, please rename it to persistent_connection. Enable/disable
use of persistent connection to receive update notif...
type: str
port:
choices:
- '53'
- '80'
- '8888'
- '443'
description: Port used to communicate with the FortiGuard servers.
type: str
protocol:
choices:
- udp
- http
- https
description: Protocol used to communicate with the FortiGuard servers.
type: str
proxy-password:
description: (list) Deprecated, please rename it to proxy_password. Proxy user
password.
type: raw
proxy-server-ip:
description: Deprecated, please rename it to proxy_server_ip. IP address of the
proxy server.
type: str
proxy-server-port:
description: Deprecated, please rename it to proxy_server_port. Port used to communicate
with the proxy server.
type: int
proxy-username:
description: Deprecated, please rename it to proxy_username. Proxy user name.
type: str
sandbox-inline-scan:
choices:
- disable
- enable
description: Deprecated, please rename it to sandbox_inline_scan. Enable/disable
FortiCloud Sandbox inline-scan.
type: str
sandbox-region:
description: Deprecated, please rename it to sandbox_region. Cloud sandbox region.
type: str
sdns-options:
choices:
- include-question-section
description: Deprecated, please rename it to sdns_options. Customization options
for the FortiGuard DNS service.
elements: str
type: list
sdns-server-ip:
description: (list) Deprecated, please rename it to sdns_server_ip. IP address
of the FortiDNS server.
type: raw
sdns-server-port:
description: Deprecated, please rename it to sdns_server_port. Port used to communicate
with FortiDNS servers.
type: int
service-account-id:
description: Deprecated, please rename it to service_account_id. Service account
ID.
type: str
source-ip:
description: Deprecated, please rename it to source_ip. Source IPv4 address used
to communicate with FortiGuard.
type: str
source-ip6:
description: Deprecated, please rename it to source_ip6. Source IPv6 address used
to communicate with FortiGuard.
type: str
update-build-proxy:
choices:
- disable
- enable
description: Deprecated, please rename it to update_build_proxy. Enable/disable
proxy dictionary rebuild.
type: str
update-dldb:
choices:
- disable
- enable
description: Deprecated, please rename it to update_dldb. Enable/disable DLP signature
update.
type: str
update-extdb:
choices:
- disable
- enable
description: Deprecated, please rename it to update_extdb. Enable/disable external
resource update.
type: str
update-ffdb:
choices:
- disable
- enable
description: Deprecated, please rename it to update_ffdb. Enable/disable Internet
Service Database update.
type: str
update-server-location:
choices:
- any
- usa
- automatic
- eu
description: Deprecated, please rename it to update_server_location. Signature
update server location.
type: str
update-uwdb:
choices:
- disable
- enable
description: Deprecated, please rename it to update_uwdb. Enable/disable allowlist
update.
type: str
vdom:
description: FortiGuard Service virtual domain name.
type: str
videofilter-expiration:
description: Deprecated, please rename it to videofilter_expiration. Videofilter-Expiration.
type: int
videofilter-license:
description: Deprecated, please rename it to videofilter_license. Videofilter-License.
type: int
webfilter-cache:
choices:
- disable
- enable
description: Deprecated, please rename it to webfilter_cache. Enable/disable FortiGuard
web filter caching.
type: str
webfilter-cache-ttl:
description: Deprecated, please rename it to webfilter_cache_ttl. Time-to-live
for web filter cache entries in seconds
type: int
webfilter-expiration:
description: Deprecated, please rename it to webfilter_expiration. Webfilter-Expiration.
type: int
webfilter-force-off:
choices:
- disable
- enable
description: Deprecated, please rename it to webfilter_force_off. Enable/disable
turning off the FortiGuard web filtering service.
type: str
webfilter-license:
description: Deprecated, please rename it to webfilter_license. Webfilter-License.
type: int
webfilter-timeout:
description: Deprecated, please rename it to webfilter_timeout. Web filter query
time out
type: int
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.
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
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