fmgr_wanprof_system_virtualwanlink_healthcheck – SD-WAN status checking or health checking.¶
New in version 2.10.
Synopsis¶
- 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.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- wanprof - The parameter in requested url type: str required: true
- wanprof_system_virtualwanlink_healthcheck - SD-WAN status checking or health checking. Identify a server on the Internet and determine how SD-WAN verifies that the FortiGate can co... type: dict
- _dynamic-server - No description for the parameter type: str
- addr-mode - Address mode (IPv4 or IPv6). type: str choices: [ipv4, ipv6]
- failtime - Number of failures before server is considered lost (1 - 3600, default = 5). type: int
- http-agent - String in the http-agent field in the HTTP header. type: str
- http-get - URL used to communicate with the server if the protocol if the protocol is HTTP. type: str
- http-match - Response string expected from the server if the protocol is HTTP. type: str
- interval - Status check interval, or the time between attempting to connect to the server (1 - 3600 sec, default = 5). type: int
- members - Member sequence number list. type: str
- name - Status check or health check name. type: str
- packet-size - Packet size of a twamp test session, type: int
- password - No description for the parameter type: str
- port - Port number used to communicate with the server over the selected protocol. type: int
- protocol - Protocol used to determine if the FortiGate can communicate with the server. type: str choices: [ping, tcp-echo, udp-echo, http, twamp, ping6]
- recoverytime - Number of successful responses received before server is considered recovered (1 - 3600, default = 5). type: int
- security-mode - Twamp controller security mode. type: str choices: [none, authentication]
- server - No description for the parameter type: str
- sla - No description for the parameter type: array
- id - SLA ID. type: int
- jitter-threshold - Jitter for SLA to make decision in milliseconds. type: int
- latency-threshold - Latency for SLA to make decision in milliseconds. type: int
- link-cost-factor - No description for the parameter type: array choices: [latency, jitter, packet-loss]
- packetloss-threshold - Packet loss for SLA to make decision in percentage. type: int
- threshold-alert-jitter - Alert threshold for jitter (ms, default = 0). type: int
- threshold-alert-latency - Alert threshold for latency (ms, default = 0). type: int
- threshold-alert-packetloss - Alert threshold for packet loss (percentage, default = 0). type: int
- threshold-warning-jitter - Warning threshold for jitter (ms, default = 0). type: int
- threshold-warning-latency - Warning threshold for latency (ms, default = 0). type: int
- threshold-warning-packetloss - Warning threshold for packet loss (percentage, default = 0). type: int
- update-cascade-interface - Enable/disable update cascade interface. type: str choices: [disable, enable]
- update-static-route - Enable/disable updating the static route. type: str choices: [disable, enable]
Notes¶
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
Examples¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: SD-WAN status checking or health checking. Identify a server on the Internet and determine how SD-WAN verifies that the FortiGate can co...
fmgr_wanprof_system_virtualwanlink_healthcheck:
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>
state: <value in [present, absent]>
wanprof_system_virtualwanlink_healthcheck:
_dynamic-server: <value of string>
addr-mode: <value in [ipv4, ipv6]>
failtime: <value of integer>
http-agent: <value of string>
http-get: <value of string>
http-match: <value of string>
interval: <value of integer>
members: <value of string>
name: <value of string>
packet-size: <value of integer>
password: <value of string>
port: <value of integer>
protocol: <value in [ping, tcp-echo, udp-echo, ...]>
recoverytime: <value of integer>
security-mode: <value in [none, authentication]>
server: <value of string>
sla:
-
id: <value of integer>
jitter-threshold: <value of integer>
latency-threshold: <value of integer>
link-cost-factor:
- latency
- jitter
- packet-loss
packetloss-threshold: <value of integer>
threshold-alert-jitter: <value of integer>
threshold-alert-latency: <value of integer>
threshold-alert-packetloss: <value of integer>
threshold-warning-jitter: <value of integer>
threshold-warning-latency: <value of integer>
threshold-warning-packetloss: <value of integer>
update-cascade-interface: <value in [disable, enable]>
update-static-route: <value in [disable, enable]>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict