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

access_token

string

The token to access FortiManager without using username and password.

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.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

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.

Choices:

  • "present"

  • "absent"

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

Address mode

Choices:

  • "ipv4"

  • "ipv6"

class-id

string

Traffic class ID.

detect-mode

string

The mode determining how to detect the server.

Choices:

  • "active"

  • "passive"

  • "prefer-passive"

  • "remote"

  • "agent-based"

diffservcode

string

Differentiated services code point

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.

embed-measured-health

string

Enable/disable embedding measured health information.

Choices:

  • "disable"

  • "enable"

failtime

integer

Number of failures before server is considered lost

ftp-file

string

Full path and file name on the FTP server to download for FTP health-check to probe.

ftp-mode

string

FTP mode.

Choices:

  • "passive"

  • "port"

ha-priority

integer

HA election priority

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

members

string

Member sequence number list.

mos-codec

string

Codec to use for MOS calculation

Choices:

  • "g711"

  • "g722"

  • "g729"

name

string

Status check or health check name.

packet-size

integer

Packet size of a twamp test session,

password

string

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

probe-packets

string

Enable/disable transmission of probe packets.

Choices:

  • "disable"

  • "enable"

probe-timeout

integer

Time to wait before a probe packet is considered lost

protocol

string

Protocol used to determine if the FortiGate can communicate with the server.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

  • "http"

  • "twamp"

  • "ping6"

  • "dns"

  • "tcp-connect"

  • "ftp"

quality-measured-method

string

Method to measure the quality of tcp-connect.

Choices:

  • "half-close"

  • "half-open"

recoverytime

integer

Number of successful responses received before server is considered recovered

security-mode

string

Twamp controller security mode.

Choices:

  • "none"

  • "authentication"

server

string

description

sla

list / elements=dictionary

description

id

integer

SLA ID.

jitter-threshold

integer

Jitter for SLA to make decision in milliseconds.

latency-threshold

integer

Latency for SLA to make decision in milliseconds.

list / elements=string

description

Choices:

  • "latency"

  • "jitter"

  • "packet-loss"

  • "mos"

mos-threshold

string

Minimum Mean Opinion Score for SLA to be marked as pass.

packetloss-threshold

integer

Packet loss for SLA to make decision in percentage.

priority-in-sla

integer

Value to be distributed into routing table when in-sla

priority-out-sla

integer

Value to be distributed into routing table when out-sla

sla-fail-log-period

integer

Time interval in seconds that SLA fail log messages will be generated

sla-id-redistribute

integer

Select the ID from the SLA sub-table.

sla-pass-log-period

integer

Time interval in seconds that SLA pass log messages will be generated

source

string

Source IP address used in the health-check packet to the server.

source6

string

Source IPv6 addressused in the health-check packet to server.

system-dns

string

Enable/disable system DNS as the probe server.

Choices:

  • "disable"

  • "enable"

threshold-alert-jitter

integer

Alert threshold for jitter

threshold-alert-latency

integer

Alert threshold for latency

threshold-alert-packetloss

integer

Alert threshold for packet loss

threshold-warning-jitter

integer

Warning threshold for jitter

threshold-warning-latency

integer

Warning threshold for latency

threshold-warning-packetloss

integer

Warning threshold for packet loss

update-cascade-interface

string

Enable/disable update cascade interface.

Choices:

  • "disable"

  • "enable"

update-static-route

string

Enable/disable updating the static route.

Choices:

  • "disable"

  • "enable"

user

string

The user name to access probe server.

vrf

integer

Virtual Routing Forwarding ID.

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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
                   - mos
                 packetloss-threshold: <value of integer>
                 mos-threshold: <value of string>
                 priority-in-sla: <value of integer>
                 priority-out-sla: <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, ...]>
           mos-codec: <value in [g711, g722, g729]>
           source: <value of string>
           vrf: <value of integer>
           embed-measured-health: <value in [disable, enable]>
           sla-id-redistribute: <value of integer>
           class-id: <value of string>
           source6: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)