Try SpotterGlobal FortiAnalyzer Cloud settings.
| "added in version" 2.1.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: Global FortiAnalyzer Cloud settings.
fortinet.fortimanager.fmgr_devprof_log_fortianalyzercloud_setting:
# 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>
devprof: <your own value>
devprof_log_fortianalyzercloud_setting:
__change_ip: <integer>
access_config: <value in [disable, enable]>
certificate: <string>
conn_timeout: <integer>
enc_algorithm: <value in [high, low, high-medium, ...]>
hmac_algorithm: <value in [sha256, sha1]>
ips_archive: <value in [disable, enable]>
monitor_failure_retry_period: <integer>
monitor_keepalive_period: <integer>
source_ip: <string>
ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
status: <value in [disable, enable]>
upload_day: <string>
upload_interval: <value in [daily, weekly, monthly]>
upload_option: <value in [store-and-upload, realtime, 1-minute, ...]>
upload_time: <string>
max_log_rate: <integer>
priority: <value in [low, default]>
interface: <string>
interface_select_method: <value in [auto, sdwan, specify]>
preshared_key: <string>
certificate_verification: <value in [disable, enable]>
serial: <list or string>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
devprof:
description: The parameter (devprof) 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
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
devprof_log_fortianalyzercloud_setting:
description: The top level parameters set.
required: false
suboptions:
__change_ip:
description: Hidden attribute.
type: int
access-config:
choices:
- disable
- enable
description: Deprecated, please rename it to access_config. Enable/disable FortiAnalyzer
access to configuration and data.
type: str
certificate:
description: Certificate used to communicate with FortiAnalyzer.
type: str
certificate-verification:
choices:
- disable
- enable
description: Deprecated, please rename it to certificate_verification. Enable/disable
identity verification of FortiAnalyzer by use of ...
type: str
conn-timeout:
description: Deprecated, please rename it to conn_timeout. FortiAnalyzer connection
time-out in seconds
type: int
enc-algorithm:
choices:
- high
- low
- high-medium
- low-medium
description: Deprecated, please rename it to enc_algorithm. Configure the level
of SSL protection for secure communication with FortiAn...
type: str
hmac-algorithm:
choices:
- sha256
- sha1
description: Deprecated, please rename it to hmac_algorithm. FortiAnalyzer IPsec
tunnel HMAC algorithm.
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
ips-archive:
choices:
- disable
- enable
description: Deprecated, please rename it to ips_archive. Enable/disable IPS packet
archive logging.
type: str
max-log-rate:
description: Deprecated, please rename it to max_log_rate. FortiAnalyzer maximum
log rate in MBps
type: int
monitor-failure-retry-period:
description: Deprecated, please rename it to monitor_failure_retry_period. Time
between FortiAnalyzer connection retries in seconds
type: int
monitor-keepalive-period:
description: Deprecated, please rename it to monitor_keepalive_period. Time between
OFTP keepalives in seconds
type: int
preshared-key:
description: Deprecated, please rename it to preshared_key. Preshared-key used
for auto-authorization on FortiAnalyzer.
type: str
priority:
choices:
- low
- default
description: Set log transmission priority.
type: str
serial:
description: (list) No description.
type: raw
source-ip:
description: Deprecated, please rename it to source_ip. Source IPv4 or IPv6 address
used to communicate with FortiAnalyzer.
type: str
ssl-min-proto-version:
choices:
- default
- TLSv1-1
- TLSv1-2
- SSLv3
- TLSv1
- TLSv1-3
description: Deprecated, please rename it to ssl_min_proto_version. Minimum supported
protocol version for SSL/TLS connections
type: str
status:
choices:
- disable
- enable
description: Enable/disable logging to FortiAnalyzer.
type: str
upload-day:
description: Deprecated, please rename it to upload_day. Day of week
type: str
upload-interval:
choices:
- daily
- weekly
- monthly
description: Deprecated, please rename it to upload_interval. Frequency to upload
log files to FortiAnalyzer.
type: str
upload-option:
choices:
- store-and-upload
- realtime
- 1-minute
- 5-minute
description: Deprecated, please rename it to upload_option. Enable/disable logging
to hard disk and then uploading to FortiAnalyzer.
type: str
upload-time:
description: Deprecated, please rename it to upload_time. Time to upload logs
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