- source
fmgr_system_logfetch_clientprofile.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> v7.2.1
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- system_logfetch_clientprofile - Log-fetch client profile settings. type: dict
- client_adom (Alias name: client-adom) Log-fetch client sides adom name. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- data_range (Alias name: data-range) Data-range for fetched logs. type: str choices: [custom] default: custom
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- data_range_value (Alias name: data-range-value) Last n days or hours. type: int default: 10
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- device_filter (Alias name: device-filter) Device-filter. type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- adom Adom name. type: str default: *
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- device Device name or serial number. type: str default: *
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- id Add or edit a device filter. type: int default: 0
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- vdom Vdom filters. type: str default: *
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- adom Adom name. type: str default: *
more...
- end_time (Alias name: end-time) End date and time of the data-range . type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- id Log-fetch client profile id. type: int default: 0
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- index_fetch_logs (Alias name: index-fetch-logs) Enable/disable indexing logs automatically after fetching logs. type: str choices: [disable, enable] default: enable
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- log_filter (Alias name: log-filter) Log-filter. type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- field Field name. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- id Log filter id. type: int default: 0
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- oper Field filter operator. type: str choices: [=, !=, <, >, <=, >=, contain, not-contain, match] default: =
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- value Field filter operand or free-text matching expression. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- field Field name. type: str
more...
- log_filter_logic (Alias name: log-filter-logic) And/or logic for log-filters. type: str choices: [and, or] default: or
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- log_filter_status (Alias name: log-filter-status) Enable/disable log-filter. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- name Name of log-fetch client profile. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- password Log-fetch server login password. type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- secure_connection (Alias name: secure-connection) Enable/disable protecting log-fetch connection with tls/ssl. type: str choices: [disable, enable] default: enable
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- server_adom (Alias name: server-adom) Log-fetch server sides adom name. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- server_ip (Alias name: server-ip) Log-fetch server ip address. type: str default: 0.0.0.0
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- start_time (Alias name: start-time) Start date and time of the data-range . type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- sync_adom_config (Alias name: sync-adom-config) Enable/disable sync adom related config. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- user Log-fetch server login username. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- peer_cert_cn (Alias name: peer-cert-cn) Certificate common name of log-fetch server. type: str
more...
Supported Version Ranges:
v7.0.3 -> v7.2.1
Note
- 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. - To create or update an object, use state: present directive. - To delete an object, use state: absent directive - 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
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Log-fetch client profile settings.
fortinet.fortimanager.fmgr_system_logfetch_clientprofile:
bypass_validation: false
state: present
system_logfetch_clientprofile:
client-adom: ansible
data-range: custom # <value in [custom]>
id: 1
index-fetch-logs: enable
name: ansible-test-clientprofile
password: fortinet
server-ip: "222.222.22.25"
user: ansible
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the Log-fetch client profile settings
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_logfetch_clientprofile"
params:
client-profile: "your_value"
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)