faz_eventmgmt_config_trigger – trigger
Added in version 1.8.0.
Warning
Starting in version 2.0.0, all variables will be named in the underscore naming convention.
Possible variable names before 2.0.0:
variable-name,variable name,variable.nameCorresponding variable names since 2.0.0:
variable_name
FortiAnalyzer Ansible v1.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.
Synopsis
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values need to be adjusted to data sources before usage.
This module supports check mode and diff mode.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.16.0
FortiAnalyzer Version Compatibility
Supported Version Ranges: v6.2.1 -> v7.2.1
Parameters
- access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
- bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
- enable_log Enable/Disable logging for task type: bool default: False
- forticloud_access_token Access token of forticloud analyzer API users. type: str
- log_path 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.logtype: str default: "/tmp/fortianalyzer.ansible.log"
- proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
- version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: False
- rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
- rc_failed The rc codes list with which the conditions to fail will be overriden type: list
- state The directive to create, update or delete an object type: str required: true choices: present, absent
- adom The parameter in requested url type: str required: true
- eventmgmt_config_trigger Trigger type: dict
- address_filter reference: /eventmgmt/adom/<adom-name>/config/trigger/<trigger_id>/address-filter type: list of dict more...
- device reference: /eventmgmt/adom/<adom-name>/config/trigger/<trigger_id>/device type: list of dict more...
- fabric_connector reference: /eventmgmt/adom/<adom-name>/config/trigger/<trigger_id>/fabric-connector type: list of dict
more...
- refid type: str more...
- filter reference: /eventmgmt/adom/<adom-name>/config/trigger/<trigger_id>/filter type: list of dict
more...
- dev_type type: raw choices: [FortiSandbox, FortiWeb, Fabric, Syslog, FortiCache, FortiAuthenticator, FortiMail, FortiProxy, FortiManager, FortiNAC, FortiAnalyzer, FortiClient, FortiDDoS, FortiGate, FortiFirewall] more...
- id type: int more...
- rule reference: /eventmgmt/adom/<adom-name>/config/trigger/<trigger_id>/filter/<filter_id>/rule type: list of dict more...
- subject type: str more...
- tag type: str more...
- enable type: str choices: [enable, disable] default: enable more...
- eventstatus type: str default: more...
- eventtype type: str more...
- extrainfo type: str more...
- extrainfo_type type: str choices: [default, custom] default: default more...
- filter_expr type: str more...
- groupby1 type: str more...
- groupby2 type: str more...
- logtype type: str default: traffic more...
- rule_relation type: int default: 0 more...
- severity type: str choices: [high, medium, critical, low] default: medium more...
- thres_count type: int default: 1 more...
- thres_duration type: int default: 30 more...
- utmevent type: str more...
- indicator reference: /log-alert/trigger/filter/indicator type: list of dict more...
- id type: int more...
- name type: str more...
- uuid type: str more...
- version type: int more...
- creation_time type: int default: 0 more...
- description type: str more...
- device_specify type: str choices: [all-devices, specify, local-host] default: more...
- email_from type: str more...
- email_html_format type: int default: 0 more...
- email_subject type: str more...
- email_svr type: str more...
- email_to type: str more...
- enable type: str choices: [enable, disable] default: enable more...
- enable_time type: int default: 0 more...
- filter_relation type: int default: 1 more...
- handlertype type: str choices: [handler-type-local, handler-type-remote] default: handler-type-local more...
- protected type: str choices: [enable, disable] default: disable more...
- snmp_community type: str more...
- snmpv3_user type: str more...
- syslog_svr type: str more...
- target_enable type: int default: 0 more...
- template_url type: str more...
- update_time type: int default: 0 more...
- content_pack_id type: str more...
- content_pack_uuid type: str more...
- pre_filter reference: /log-alert/trigger/pre-filter type: list of dict more...
Notes
Note
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
Examples
- name: Example playbook
hosts: fortianalyzers
connection: httpapi
gather_facts: false
vars:
ansible_network_os: fortinet.fortianalyzer.fortianalyzer
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
tasks:
- name: Trigger
fortinet.fortianalyzer.faz_eventmgmt_config_trigger:
# bypass_validation: false
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
eventmgmt_config_trigger:
id: 0 # Required variable, integer
# address_filter:
# - id: <value of integer>
# include_option: <any type of data>
# address_type: <value in [address-group, address-obj]>
# grp_name: <value of string>
# obj_name: <value of string>
# device:
# - id: <value of integer>
# name: <value of string>
# type: <any type of data>
# vdom: <value of string>
# fabric_connector:
# - refid: <value of string>
# filter:
# - dev_type: <any type of data>
# id: <value of integer>
# rule:
# - id: <value of integer>
# key: <value of string>
# value: <value of string>
# value_type: <value of integer>
# oper: <value in [less-than, not-contain, less-or-equal, ...]>
# subject: <value of string>
# tag: <value of string>
# enable: <value in [enable, disable]>
# eventstatus: <value of string>
# eventtype: <value of string>
# extrainfo: <value of string>
# extrainfo_type: <value in [default, custom]>
# filter_expr: <value of string>
# groupby1: <value of string>
# groupby2: <value of string>
# logtype: <value of string>
# rule_relation: <value of integer>
# severity: <value in [high, medium, critical, ...]>
# thres_count: <value of integer>
# thres_duration: <value of integer>
# utmevent: <value of string>
# indicator:
# - count: <value of integer>
# name: <value of string>
# type: <value of string>
# name: <value of string>
# uuid: <value of string>
# version: <value of integer>
# creation_time: <value of integer>
# description: <value of string>
# device_specify: <value in [all-devices, specify, local-host]>
# email_from: <value of string>
# email_html_format: <value of integer>
# email_subject: <value of string>
# email_svr: <value of string>
# email_to: <value of string>
# enable: <value in [enable, disable]>
# enable_time: <value of integer>
# filter_relation: <value of integer>
# handlertype: <value in [handler-type-local, handler-type-remote]>
# protected: <value in [enable, disable]>
# snmp_community: <value of string>
# snmpv3_user: <value of string>
# syslog_svr: <value of string>
# target_enable: <value of integer>
# template_url: <value of string>
# update_time: <value of integer>
# content_pack_id: <value of string>
# content_pack_uuid: <value of string>
# pre_filter:
# - dev_type: <any type of data>
# id: <value of integer>
# rule:
# - id: <value of integer>
# key: <value of string>
# value: <value of string>
# value_type: <value of integer>
# subject: <value of string>
# tag: <value of string>
Return Values
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 fortianalyzer version. returned: if params are not supported in the current version type: list
Status
This module is not guaranteed to have a backwards compatible interface.