fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_alertconsole Alert console. | "added in version" 2.0.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_alertconsole (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: Alert console. fortinet.fortimanager.fmgr_system_alertconsole: # 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, ...] system_alertconsole: period: <value in [1, 2, 3, ...]> severity_level: - debug - information - notify - warning - error - critical - alert - emergency
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 system_alertconsole: description: The top level parameters set. required: false suboptions: period: choices: - '1' - '2' - '3' - '4' - '5' - '6' - '7' description: - Alert console keeps alerts for this period. - 1 - 1 day. - 2 - 2 days. - 3 - 3 days. - 4 - 4 days. - 5 - 5 days. - 6 - 6 days. - 7 - 7 days. type: str severity-level: choices: - debug - information - notify - warning - error - critical - alert - emergency description: - Deprecated, please rename it to severity_level. - Alert console keeps alerts of this and higher severity. - debug - Debug level. - information - Information level. - notify - Notify level. - warning - Warning level. - error - Error level. - critical - Critical level. - alert - Alert level. - emergency - Emergency level. elements: str type: list type: dict 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 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