fortinet.fortimanager.fmgr_wanprof_system_sdwan_healthcheck module – SD-WAN status checking or health checking.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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_sdwan_healthcheck
.
New in fortinet.fortimanager 2.1.0
Synopsis
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.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The parameter (wanprof) in requested url. |
|
The top level parameters set. |
|
Deprecated, please rename it to _dynamic_server. Dynamic server. |
|
Deprecated, please rename it to addr_mode. Address mode Choices:
|
|
Deprecated, please rename it to class_id. Traffic class ID. |
|
Deprecated, please rename it to detect_mode. The mode determining how to detect the server. Choices:
|
|
Differentiated services code point |
|
Deprecated, please rename it to dns_match_ip. Response IP expected from DNS server if the protocol is DNS. |
|
Deprecated, please rename it to dns_request_domain. Fully qualified domain name to resolve for the DNS probe. |
|
Deprecated, please rename it to embed_measured_health. Enable/disable embedding measured health information. Choices:
|
|
Number of failures before server is considered lost |
|
Deprecated, please rename it to ftp_file. Full path and file name on the FTP server to download for FTP health-check to probe. |
|
Deprecated, please rename it to ftp_mode. FTP mode. Choices:
|
|
Deprecated, please rename it to ha_priority. HA election priority |
|
Deprecated, please rename it to http_agent. String in the http-agent field in the HTTP header. |
|
Deprecated, please rename it to http_get. URL used to communicate with the server if the protocol if the protocol is HTTP. |
|
Deprecated, please rename it to http_match. Response string expected from the server if the protocol is HTTP. |
|
Status check interval in milliseconds, or the time between attempting to connect to the server |
|
(list or str) Member sequence number list. |
|
Deprecated, please rename it to mos_codec. Codec to use for MOS calculation Choices:
|
|
Status check or health check name. |
|
Deprecated, please rename it to packet_size. Packet size of a twamp test session, |
|
(list) Twamp controller password in authentication mode |
|
Port number used to communicate with the server over the selected protocol |
|
Deprecated, please rename it to probe_count. Number of most recent probes that should be used to calculate latency and jitter |
|
Deprecated, please rename it to probe_packets. Enable/disable transmission of probe packets. Choices:
|
|
Deprecated, please rename it to probe_timeout. Time to wait before a probe packet is considered lost |
|
Protocol used to determine if the FortiGate can communicate with the server. Choices:
|
|
Deprecated, please rename it to quality_measured_method. Method to measure the quality of tcp-connect. Choices:
|
|
Number of successful responses received before server is considered recovered |
|
Deprecated, please rename it to security_mode. Twamp controller security mode. Choices:
|
|
(list) IP address or FQDN name of the server. |
|
Sla. |
|
SLA ID. |
|
Deprecated, please rename it to jitter_threshold. Jitter for SLA to make decision in milliseconds. |
|
Deprecated, please rename it to latency_threshold. Latency for SLA to make decision in milliseconds. |
|
Deprecated, please rename it to link_cost_factor. Criteria on which to base link selection. Choices:
|
|
Deprecated, please rename it to mos_threshold. Minimum Mean Opinion Score for SLA to be marked as pass. |
|
Deprecated, please rename it to packetloss_threshold. Packet loss for SLA to make decision in percentage. |
|
Deprecated, please rename it to priority_in_sla. Value to be distributed into routing table when in-sla |
|
Deprecated, please rename it to priority_out_sla. Value to be distributed into routing table when out-sla |
|
Deprecated, please rename it to sla_fail_log_period. Time interval in seconds that SLA fail log messages will be generated |
|
Deprecated, please rename it to sla_id_redistribute. Select the ID from the SLA sub-table. |
|
Deprecated, please rename it to sla_pass_log_period. Time interval in seconds that SLA pass log messages will be generated |
|
Source IP address used in the health-check packet to the server. |
|
Source IPv6 addressused in the health-check packet to server. |
|
Deprecated, please rename it to system_dns. Enable/disable system DNS as the probe server. Choices:
|
|
Deprecated, please rename it to threshold_alert_jitter. Alert threshold for jitter |
|
Deprecated, please rename it to threshold_alert_latency. Alert threshold for latency |
|
Deprecated, please rename it to threshold_alert_packetloss. Alert threshold for packet loss |
|
Deprecated, please rename it to threshold_warning_jitter. Warning threshold for jitter |
|
Deprecated, please rename it to threshold_warning_latency. Warning threshold for latency |
|
Deprecated, please rename it to threshold_warning_packetloss. Warning threshold for packet loss |
|
Deprecated, please rename it to update_cascade_interface. Enable/disable update cascade interface. Choices:
|
|
Deprecated, please rename it to update_static_route. Enable/disable updating the static route. Choices:
|
|
The user name to access probe server. |
|
Virtual Routing Forwarding ID. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
- 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: SD-WAN status checking or health checking.
fortinet.fortimanager.fmgr_wanprof_system_sdwan_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: present # <value in [present, absent]>
wanprof_system_sdwan_healthcheck:
_dynamic_server: <string>
addr_mode: <value in [ipv4, ipv6]>
diffservcode: <string>
dns_match_ip: <string>
dns_request_domain: <string>
failtime: <integer>
ftp_file: <string>
ftp_mode: <value in [passive, port]>
ha_priority: <integer>
http_agent: <string>
http_get: <string>
http_match: <string>
interval: <integer>
members: <list or string>
name: <string>
packet_size: <integer>
password: <list or string>
port: <integer>
probe_count: <integer>
probe_packets: <value in [disable, enable]>
probe_timeout: <integer>
protocol: <value in [ping, tcp-echo, udp-echo, ...]>
quality_measured_method: <value in [half-close, half-open]>
recoverytime: <integer>
security_mode: <value in [none, authentication]>
server: <list or string>
sla:
-
id: <integer>
jitter_threshold: <integer>
latency_threshold: <integer>
link_cost_factor:
- latency
- jitter
- packet-loss
- mos
- remote
packetloss_threshold: <integer>
mos_threshold: <string>
priority_in_sla: <integer>
priority_out_sla: <integer>
sla_fail_log_period: <integer>
sla_pass_log_period: <integer>
system_dns: <value in [disable, enable]>
threshold_alert_jitter: <integer>
threshold_alert_latency: <integer>
threshold_alert_packetloss: <integer>
threshold_warning_jitter: <integer>
threshold_warning_latency: <integer>
threshold_warning_packetloss: <integer>
update_cascade_interface: <value in [disable, enable]>
update_static_route: <value in [disable, enable]>
user: <string>
detect_mode: <value in [active, passive, prefer-passive, ...]>
mos_codec: <value in [g711, g722, g729]>
source: <string>
vrf: <integer>
embed_measured_health: <value in [disable, enable]>
sla_id_redistribute: <integer>
class_id: <string>
source6: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |