fortinet.fortimanager.fmgr_log_npuserver module – Configure all the log servers and create the server groups.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_log_npuserver.
New in fortinet.fortimanager 2.2.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The top level parameters set. |
|
Sw session netflow logs will be delivered in strict order if the option is enabled. Choices:
|
|
Configure the syslog facility. |
|
Configure log processed by host to drop or no drop. Choices:
|
|
Configure the log module. Choices:
|
|
Configure the netfow verson. Choices:
|
|
Server group. |
|
Server group name. |
|
Set the log format Choices:
|
|
Enable/disbale generating event for Per-Mapping log Choices:
|
|
Set the log mode Choices:
|
|
Configure log transmit mode. Choices:
|
|
Enable/disbale logging user information. Choices:
|
|
Server number in this group. |
|
The start id of the continuous server series in this group,[1,16]. |
|
(int or str) Set flags for software logging via driver. |
|
Server info. |
|
Set the dest port for the log packet |
|
Server id. |
|
Set the version the IP address Choices:
|
|
Set the IPv4 address for the log server |
|
Set the IPv6 address for the log server |
|
Set transport protocol Choices:
|
|
Set the source port for the log packet |
|
Set the template tx timeout |
|
Interface connected to the log server is in this virtual domain |
|
Configure the syslog severity. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- 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]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |