Try SpotterConfigure all the log servers and create the server groups.
| "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 all the log servers and create the server groups.
fortinet.fortimanager.fmgr_log_npuserver:
# 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>
log_npuserver:
log_processing: <value in [may-drop, no-drop]>
log_processor: <value in [hardware, host]>
netflow_ver: <value in [v9, v10]>
server_group:
-
group_name: <string>
log_format: <value in [syslog, netflow]>
log_mode: <value in [per-session, per-nat-mapping, per-session-ending]>
log_tx_mode: <value in [multicast, roundrobin]>
server_number: <integer>
server_start_id: <integer>
sw_log_flags: <integer or string> <value in [tcp-udp-only, enable-all-log, disable-all-log]>
log_gen_event: <value in [disable, enable]>
log_user_info: <value in [disable, enable]>
server_info:
-
dest_port: <integer>
id: <integer>
ip_family: <value in [v4, v6]>
ipv4_server: <string>
ipv6_server: <string>
source_port: <integer>
template_tx_timeout: <integer>
vdom: <string>
log_transport: <value in [udp, tcp]>
fmgr_syslog_facility: <integer>
syslog_severity: <integer>
enforce_seq_order: <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
log_npuserver:
description: The top level parameters set.
required: false
suboptions:
enforce-seq-order:
choices:
- disable
- enable
description: Deprecated, please rename it to enforce_seq_order. Sw session netflow
logs will be delivered in strict order if the option...
type: str
log-processing:
choices:
- may-drop
- no-drop
description: Deprecated, please rename it to log_processing. Configure log processed
by host to drop or no drop.
type: str
log-processor:
choices:
- hardware
- host
description: Deprecated, please rename it to log_processor. Configure the log
module.
type: str
netflow-ver:
choices:
- v9
- v10
description: Deprecated, please rename it to netflow_ver. Configure the netfow
verson.
type: str
server-group:
description: Deprecated, please rename it to server_group.
elements: dict
suboptions:
group-name:
description: Deprecated, please rename it to group_name. Server group name.
type: str
log-format:
choices:
- syslog
- netflow
description: Deprecated, please rename it to log_format. Set the log format
type: str
log-gen-event:
choices:
- disable
- enable
description: Deprecated, please rename it to log_gen_event. Enable/disbale
generating event for Per-Mapping log
type: str
log-mode:
choices:
- per-session
- per-nat-mapping
- per-session-ending
description: Deprecated, please rename it to log_mode. Set the log mode
type: str
log-tx-mode:
choices:
- multicast
- roundrobin
description: Deprecated, please rename it to log_tx_mode. Configure log transmit
mode.
type: str
log-user-info:
choices:
- disable
- enable
description: Deprecated, please rename it to log_user_info. Enable/disbale
logging user information.
type: str
server-number:
description: Deprecated, please rename it to server_number. Server number
in this group.
type: int
server-start-id:
description: Deprecated, please rename it to server_start_id. The start id
of the continuous server series in this group,[1,16].
type: int
sw-log-flags:
description: (int or str) Deprecated, please rename it to sw_log_flags. Set
flags for software logging via driver.
type: raw
type: list
server-info:
description: Deprecated, please rename it to server_info.
elements: dict
suboptions:
dest-port:
description: Deprecated, please rename it to dest_port. Set the dest port
for the log packet
type: int
id:
description: Server id.
type: int
ip-family:
choices:
- v4
- v6
description: Deprecated, please rename it to ip_family. Set the version the
IP address
type: str
ipv4-server:
description: Deprecated, please rename it to ipv4_server. Set the IPv4 address
for the log server
type: str
ipv6-server:
description: Deprecated, please rename it to ipv6_server. Set the IPv6 address
for the log server
type: str
log-transport:
choices:
- udp
- tcp
description: Deprecated, please rename it to log_transport. Set transport
protocol
type: str
source-port:
description: Deprecated, please rename it to source_port. Set the source port
for the log packet
type: int
template-tx-timeout:
description: Deprecated, please rename it to template_tx_timeout. Set the
template tx timeout
type: int
vdom:
description: Interface connected to the log server is in this virtual domain
type: str
type: list
syslog-facility:
description: Deprecated, please rename it to fmgr_syslog_facility. Configure the
syslog facility.
type: int
syslog-severity:
description: Deprecated, please rename it to syslog_severity. Configure the syslog
severity.
type: int
type: dict
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
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