Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck.
New in version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | |||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
| enable_log boolean |
| Enable/Disable logging for task | ||
| proposed_method string |
| The overridden method for the underlying Json RPC request | ||
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | |||
| rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | |||
| state string / required |
| the directive to create, update or delete an object | ||
| wanprof string / required | the parameter (wanprof) in requested url | |||
| wanprof_system_virtualwanlink_healthcheck dictionary | the top level parameters set | |||
| _dynamic-server string | no description | |||
| addr-mode string |
| Address mode (IPv4 or IPv6). | ||
| diffservcode string | Differentiated services code point (DSCP) in the IP header of the probe packet. | |||
| dns-request-domain string | Fully qualified domain name to resolve for the DNS probe. | |||
| failtime integer | Number of failures before server is considered lost (1 - 3600, default = 5). | |||
| ha-priority integer | HA election priority (1 - 50). | |||
| http-agent string | String in the http-agent field in the HTTP header. | |||
| http-get string | URL used to communicate with the server if the protocol if the protocol is HTTP. | |||
| http-match string | Response string expected from the server if the protocol is HTTP. | |||
| internet-service-id string | Internet service ID. | |||
| interval integer | Status check interval, or the time between attempting to connect to the server (1 - 3600 sec, default = 5). | |||
| members string | Member sequence number list. | |||
| name string | Status check or health check name. | |||
| packet-size integer | Packet size of a twamp test session, | |||
| password string | no description | |||
| port integer | Port number used to communicate with the server over the selected protocol. | |||
| probe-count integer | Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30). | |||
| probe-packets string |
| Enable/disable transmission of probe packets. | ||
| probe-timeout integer | Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500). | |||
| protocol string |
| Protocol used to determine if the FortiGate can communicate with the server. | ||
| recoverytime integer | Number of successful responses received before server is considered recovered (1 - 3600, default = 5). | |||
| security-mode string |
| Twamp controller security mode. | ||
| server string | no description | |||
| sla list / elements=string | no description | |||
| id integer | SLA ID. | |||
| jitter-threshold integer | Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5). | |||
| latency-threshold integer | Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5). | |||
| link-cost-factor list / elements=string |
| no description | ||
| packetloss-threshold integer | Packet loss for SLA to make decision in percentage. (0 - 100, default = 0). | |||
| sla-fail-log-period integer | Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0). | |||
| sla-pass-log-period integer | Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0). | |||
| system-dns string |
| Enable/disable system DNS as the probe server. | ||
| threshold-alert-jitter integer | Alert threshold for jitter (ms, default = 0). | |||
| threshold-alert-latency integer | Alert threshold for latency (ms, default = 0). | |||
| threshold-alert-packetloss integer | Alert threshold for packet loss (percentage, default = 0). | |||
| threshold-warning-jitter integer | Warning threshold for jitter (ms, default = 0). | |||
| threshold-warning-latency integer | Warning threshold for latency (ms, default = 0). | |||
| threshold-warning-packetloss integer | Warning threshold for packet loss (percentage, default = 0). | |||
| update-cascade-interface string |
| Enable/disable update cascade interface. | ||
| update-static-route string |
| Enable/disable updating the static route. | ||
| workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | |||
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | ||
Note
- 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.
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]>
internet-service-id: <value of string>
probe-packets: <value in [disable, enable]>
sla-fail-log-period: <value of integer>
sla-pass-log-period: <value of integer>
ha-priority: <value of integer>
diffservcode: <value of string>
probe-timeout: <value of integer>
dns-request-domain: <value of string>
probe-count: <value of integer>
system-dns: <value in [disable, enable]>
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_wanprof_system_virtualwanlink_healthcheck_module.html