W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_wanprof_system_sdwan_healthcheck – SD-WAN status checking or health checking.

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_sdwan_healthcheck.

New in version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
wanprof
string / required
the parameter (wanprof) in requested url
wanprof_system_sdwan_healthcheck
dictionary
the top level parameters set
_dynamic-server
string
no description
addr-mode
string
    Choices:
  • ipv4
  • ipv6
Address mode (IPv4 or IPv6).
detect-mode
string
    Choices:
  • active
  • passive
  • prefer-passive
The mode determining how to detect the server.
diffservcode
string
Differentiated services code point (DSCP) in the IP header of the probe packet.
dns-match-ip
string
Response IP expected from DNS server if the protocol is DNS.
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).
ftp-file
string
Full path and file name on the FTP server to download for FTP health-check to probe.
ftp-mode
string
    Choices:
  • passive
  • port
FTP mode.
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.
interval
integer
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default ...
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 (0-65535, default = 0, auto select. http, twamp: 80...
probe-count
integer
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
probe-packets
string
    Choices:
  • disable
  • enable
Enable/disable transmission of probe packets.
probe-timeout
integer
Time to wait before a probe packet is considered lost (500 - 3600*1000 msec, default = 500).
protocol
string
    Choices:
  • ping
  • tcp-echo
  • udp-echo
  • http
  • twamp
  • ping6
  • dns
  • tcp-connect
  • ftp
Protocol used to determine if the FortiGate can communicate with the server.
quality-measured-method
string
    Choices:
  • half-close
  • half-open
Method to measure the quality of tcp-connect.
recoverytime
integer
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
security-mode
string
    Choices:
  • none
  • authentication
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
    Choices:
  • latency
  • jitter
  • packet-loss
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
    Choices:
  • disable
  • enable
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
    Choices:
  • disable
  • enable
Enable/disable update cascade interface.
update-static-route
string
    Choices:
  • disable
  • enable
Enable/disable updating the static route.
user
string
The user name to access probe server.
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

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.
     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: <value in [present, absent]>
        wanprof_system_sdwan_healthcheck:
           _dynamic-server: <value of string>
           addr-mode: <value in [ipv4, ipv6]>
           diffservcode: <value of string>
           dns-match-ip: <value of string>
           dns-request-domain: <value of string>
           failtime: <value of integer>
           ftp-file: <value of string>
           ftp-mode: <value in [passive, port]>
           ha-priority: <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>
           probe-count: <value of integer>
           probe-packets: <value in [disable, enable]>
           probe-timeout: <value of integer>
           protocol: <value in [ping, tcp-echo, udp-echo, ...]>
           quality-measured-method: <value in [half-close, half-open]>
           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>
           sla-fail-log-period: <value of integer>
           sla-pass-log-period: <value of integer>
           system-dns: <value in [disable, enable]>
           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]>
           user: <value of string>
           detect-mode: <value in [active, passive, prefer-passive]>

Return Values

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.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 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_sdwan_healthcheck_module.html