fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck module – SD-WAN status checking or health checking.
Note
This module is part of the fortinet.fortimanager collection (version 2.9.1).
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 fortinet.fortimanager 2.0.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. |
|
Dynamic server. |
|
Address mode Choices:
|
|
Differentiated services code point |
|
Fully qualified domain name to resolve for the DNS probe. |
|
Number of failures before server is considered lost |
|
HA election priority |
|
String in the http-agent field in the HTTP header. |
|
URL used to communicate with the server if the protocol if the protocol is HTTP. |
|
Response string expected from the server if the protocol is HTTP. |
|
Internet service ID. |
|
Status check interval, or the time between attempting to connect to the server |
|
(list or str) Member sequence number list. |
|
Status check or health check name. |
|
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. |
|
Number of most recent probes that should be used to calculate latency and jitter |
|
Enable/disable transmission of probe packets. Choices:
|
|
Time to wait before a probe packet is considered lost |
|
Protocol used to determine if the FortiGate can communicate with the server. Choices:
|
|
Number of successful responses received before server is considered recovered |
|
Twamp controller security mode. Choices:
|
|
(list) IP address or FQDN name of the server. |
|
Sla. |
|
SLA ID. |
|
Jitter for SLA to make decision in milliseconds. |
|
Latency for SLA to make decision in milliseconds. |
|
Criteria on which to base link selection. Choices:
|
|
Packet loss for SLA to make decision in percentage. |
|
Time interval in seconds that SLA fail log messages will be generated |
|
Time interval in seconds that SLA pass log messages will be generated |
|
Enable/disable system DNS as the probe server. Choices:
|
|
Alert threshold for jitter |
|
Alert threshold for latency |
|
Alert threshold for packet loss |
|
Warning threshold for jitter |
|
Warning threshold for latency |
|
Warning threshold for packet loss |
|
How long to wait before not receiving a reply from the server to consider the connetion attempt a failure |
|
Enable/disable update cascade interface. Choices:
|
|
Enable/disable updating the static route. Choices:
|
|
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_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: present # <value in [present, absent]>
wanprof_system_virtualwanlink_healthcheck:
name: "your value" # Required variable, string
# _dynamic_server: <string>
# addr_mode: <value in [ipv4, ipv6]>
# failtime: <integer>
# http_agent: <string>
# http_get: <string>
# http_match: <string>
# interval: <integer>
# members: <list or string>
# packet_size: <integer>
# password: <list or string>
# port: <integer>
# protocol: <value in [ping, tcp-echo, udp-echo, ...]>
# 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"
# packetloss_threshold: <integer>
# 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]>
# internet_service_id: <string>
# probe_packets: <value in [disable, enable]>
# sla_fail_log_period: <integer>
# sla_pass_log_period: <integer>
# timeout: <integer>
# ha_priority: <integer>
# diffservcode: <string>
# probe_timeout: <integer>
# dns_request_domain: <string>
# probe_count: <integer>
# system_dns: <value in [disable, enable]>
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 |