fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_wanprof_system_sdwan_healthcheck_sla Service level agreement | "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_wanprof_system_sdwan_healthcheck_sla (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: Service level agreement fortinet.fortimanager.fmgr_wanprof_system_sdwan_healthcheck_sla: # 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, ...] adom: <your own value> wanprof: <your own value> health_check: <your own value> state: present # <value in [present, absent]> wanprof_system_sdwan_healthcheck_sla: id: <integer> jitter_threshold: <integer> latency_threshold: <integer> link_cost_factor: - latency - jitter - packet-loss - mos packetloss_threshold: <integer> mos_threshold: <string> priority_in_sla: <integer> priority_out_sla: <integer>
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str wanprof: description: The parameter (wanprof) in requested url. 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 health-check: description: Deprecated, please use "health_check" type: str health_check: description: The parameter (health-check) in requested url. 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 workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int wanprof_system_sdwan_healthcheck_sla: description: The top level parameters set. required: false suboptions: id: description: SLA ID. required: true type: int jitter-threshold: description: Deprecated, please rename it to jitter_threshold. Jitter for SLA to make decision in milliseconds. type: int latency-threshold: description: Deprecated, please rename it to latency_threshold. Latency for SLA to make decision in milliseconds. type: int link-cost-factor: choices: - latency - jitter - packet-loss - mos description: Deprecated, please rename it to link_cost_factor. elements: str type: list mos-threshold: description: Deprecated, please rename it to mos_threshold. Minimum Mean Opinion Score for SLA to be marked as pass. type: str packetloss-threshold: description: Deprecated, please rename it to packetloss_threshold. Packet loss for SLA to make decision in percentage. type: int priority-in-sla: description: Deprecated, please rename it to priority_in_sla. Value to be distributed into routing table when in-sla type: int priority-out-sla: description: Deprecated, please rename it to priority_out_sla. Value to be distributed into routing table when out-sla type: int 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 FortiManager version. returned: complex type: list