fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_sql_customskipidx List of aditional SQL skip index fields. | "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 communityfortinet.fortimanager.fmgr_system_sql_customskipidx (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- 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: List of aditional SQL skip index fields. fortinet.fortimanager.fmgr_system_sql_customskipidx: # 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, ...] state: present # <value in [present, absent]> system_sql_customskipidx: device_type: <value in [FortiGate, FortiManager, FortiClient, ...]> id: <integer> index_field: <string> log_type: <value in [app-ctrl, attack, content, ...]>
state: choices: - present - absent description: The directive to create, update or delete an object. 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 system_sql_customskipidx: description: The top level parameters set. required: false suboptions: device-type: choices: - FortiGate - FortiManager - FortiClient - FortiMail - FortiWeb - FortiSandbox - FortiProxy description: - Deprecated, please rename it to device_type. - Device type. - FortiGate - Set device type to FortiGate. - FortiManager - Set device type to FortiManager - FortiClient - Set device type to FortiClient. - FortiMail - Set device type to FortiMail. - FortiWeb - Set device type to FortiWeb. - FortiSandbox - Set device type to FortiSandbox - FortiProxy - Set device type to FortiProxy type: str id: description: Add or Edit log index fields. required: true type: int index-field: description: Deprecated, please rename it to index_field. Field to be added to skip index. type: str log-type: choices: - app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset - protocol - siem - ztna - security description: - Deprecated, please rename it to log_type. - Log type. - app-ctrl - attack - content - dlp - emailfilter - event - generic - history - traffic - virus - voip - webfilter - netscan - fct-event - fct-traffic - fct-netscan - waf - gtp - dns - ssh - ssl - file-filter - asset type: str type: dict 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