Try SpotterLog-fetch client profile settings.
| "added in version" 1.0.0 of dux_fortinet.fortianalyzer_dev"
Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install dux_fortinet.fortianalyzer_dev:==1.4.0
collections:
- name: dux_fortinet.fortianalyzer_dev
version: 1.4.0This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook
connection: httpapi
hosts: fortianalyzers
tasks:
- name: Log-fetch client profile settings.
fortinet.fortianalyzer.faz_cli_system_logfetch_clientprofile:
cli_system_logfetch_clientprofile:
id: 1
index_fetch_logs: disable
log_filter_status: disable
secure_connection: disable
sync_adom_config: disable
server_ip: 34.54.65.75
name: fooclientprofile
user: "admin"
password: "password"
state: present
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
state:
choices:
- present
- absent
description: The directive to create, update or delete an object
required: true
type: str
log_path:
default: /tmp/fortianalyzer.ansible.log
description:
- The path to save log. Used if enable_log is true.
- Please use absolute path instead of relative path.
- If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log
required: false
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:
- set
- update
- 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 FortiAnalyzer API structure,
module continues to execute without validating parameters
required: false
type: bool
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
cli_system_logfetch_clientprofile:
description: The top level parameters set.
required: false
suboptions:
client-adom:
description: Log-fetch client sides adom name.
type: str
data-range:
choices:
- custom
description:
- Data-range for fetched logs.
- custom - Specify some other date and time range.
type: str
data-range-value:
description: Last n days or hours.
type: int
device-filter:
description: no description
elements: dict
suboptions:
adom:
description: Adom name.
type: str
device:
description: Device name or Serial number.
type: str
id:
description: Add or edit a device filter.
type: int
vdom:
description: Vdom filters.
type: str
type: list
end-time:
description: no description
type: str
id:
description: Log-fetch client profile ID.
type: int
index-fetch-logs:
choices:
- disable
- enable
description:
- Enable/Disable indexing logs automatically after fetching logs.
- disable - Disable attribute function.
- enable - Enable attribute function.
type: str
log-filter:
description: no description
elements: dict
suboptions:
field:
description: Field name.
type: str
id:
description: Log filter ID.
type: int
oper:
choices:
- '='
- '!='
- <
- '>'
- <=
- '>='
- contain
- not-contain
- match
description:
- Field filter operator.
- '< - =Less than or equal to'
- '> - =Greater than or equal to'
- contain - Contain
- not-contain - Not contain
- match - Match (expression)
type: str
value:
description: Field filter operand or free-text matching expression.
type: str
type: list
log-filter-logic:
choices:
- and
- or
description:
- And/Or logic for log-filters.
- and - Logic And.
- or - Logic Or.
type: str
log-filter-status:
choices:
- disable
- enable
description:
- Enable/Disable log-filter.
- disable - Disable attribute function.
- enable - Enable attribute function.
type: str
name:
description: Name of log-fetch client profile.
type: str
password:
description: no description
type: str
peer-cert-cn:
description: Certificate common name of log-fetch server.
type: str
secure-connection:
choices:
- disable
- enable
description:
- Enable/Disable protecting log-fetch connection with TLS/SSL.
- disable - Disable attribute function.
- enable - Enable attribute function.
type: str
server-adom:
description: Log-fetch server sides adom name.
type: str
server-ip:
description: Log-fetch server IP address.
type: str
start-time:
description: no description
type: str
sync-adom-config:
choices:
- disable
- enable
description:
- Enable/Disable sync adom related config.
- disable - Disable attribute function.
- enable - Enable attribute function.
type: str
user:
description: Log-fetch server login username.
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 fortianalyzer version.
returned: complex
type: list