fmgr_wanprof_system_sdwan_healthcheck – SD-WAN status checking or health checking.

New in version 2.1.0.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.
  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
False
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10
False False False False False False False False False False
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11
False True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7
True True True True True True True True
7.2.0 7.2.1 7.2.2
True True True
7.4.0
True

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • wanprof - The parameter in requested url type: str required: true
  • wanprof_system_sdwan_healthcheck - SD-WAN status checking or health checking. type: dict
    • _dynamic-server - No description for the parameter type: str more...
    • addr-mode - Address mode (IPv4 or IPv6). type: str choices: [ipv4, ipv6] more...
    • diffservcode - Differentiated services code point (DSCP) in the IP header of the probe packet. type: str more...
    • dns-match-ip - Response IP expected from DNS server if the protocol is DNS. type: str more...
    • dns-request-domain - Fully qualified domain name to resolve for the DNS probe. type: str more...
    • failtime - Number of failures before server is considered lost (1 - 3600, default = 5). type: int more...
    • ftp-file - Full path and file name on the FTP server to download for FTP health-check to probe. type: str more...
    • ftp-mode - FTP mode. type: str choices: [passive, port] more...
    • ha-priority - HA election priority (1 - 50). type: int more...
    • http-agent - String in the http-agent field in the HTTP header. type: str more...
    • http-get - URL used to communicate with the server if the protocol if the protocol is HTTP. type: str more...
    • http-match - Response string expected from the server if the protocol is HTTP. type: str more...
    • interval - Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500). type: int more...
    • members - Member sequence number list. type: str more...
    • name - Status check or health check name. type: str more...
    • packet-size - Packet size of a twamp test session, type: int more...
    • password - No description for the parameter type: str more...
    • port - Port number used to communicate with the server over the selected protocol (0-65535, default = 0, auto select. type: int more...
    • probe-count - Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30). type: int more...
    • probe-packets - Enable/disable transmission of probe packets. type: str choices: [disable, enable] more...
    • probe-timeout - Time to wait before a probe packet is considered lost (500 - 3600*1000 msec, default = 500). type: int more...
    • protocol - Protocol used to determine if the FortiGate can communicate with the server. type: str choices: [ping, tcp-echo, udp-echo, http, twamp, ping6, dns, tcp-connect, ftp] more...
    • quality-measured-method - Method to measure the quality of tcp-connect. type: str choices: [half-close, half-open] more...
    • recoverytime - Number of successful responses received before server is considered recovered (1 - 3600, default = 5). type: int more...
    • security-mode - Twamp controller security mode. type: str choices: [none, authentication] more...
    • server - No description for the parameter type: str more...
    • sla - No description for the parameter type: array more...
      • id - SLA ID. type: int more...
      • jitter-threshold - Jitter for SLA to make decision in milliseconds. type: int more...
      • latency-threshold - Latency for SLA to make decision in milliseconds. type: int more...
      • link-cost-factor - No description for the parameter type: array choices: [latency, jitter, packet-loss, mos] more...
      • packetloss-threshold - Packet loss for SLA to make decision in percentage. type: int more...
      • mos-threshold - Minimum Mean Opinion Score for SLA to be marked as pass. type: str more...
      • priority-in-sla - Value to be distributed into routing table when in-sla (0 - 65535, default = 0). type: int more...
      • priority-out-sla - Value to be distributed into routing table when out-sla (0 - 65535, default = 0). type: int more...
    • sla-fail-log-period - Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0). type: int more...
    • sla-pass-log-period - Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0). type: int more...
    • system-dns - Enable/disable system DNS as the probe server. type: str choices: [disable, enable] more...
    • threshold-alert-jitter - Alert threshold for jitter (ms, default = 0). type: int more...
    • threshold-alert-latency - Alert threshold for latency (ms, default = 0). type: int more...
    • threshold-alert-packetloss - Alert threshold for packet loss (percentage, default = 0). type: int more...
    • threshold-warning-jitter - Warning threshold for jitter (ms, default = 0). type: int more...
    • threshold-warning-latency - Warning threshold for latency (ms, default = 0). type: int more...
    • threshold-warning-packetloss - Warning threshold for packet loss (percentage, default = 0). type: int more...
    • update-cascade-interface - Enable/disable update cascade interface. type: str choices: [disable, enable] more...
    • update-static-route - Enable/disable updating the static route. type: str choices: [disable, enable] more...
    • user - The user name to access probe server. type: str more...
    • detect-mode - The mode determining how to detect the server. type: str choices: [active, passive, prefer-passive, remote, agent-based] more...
    • mos-codec - Codec to use for MOS calculation (default = g711). type: str choices: [g711, g722, g729] more...
    • source - Source IP address used in the health-check packet to the server. type: str more...
    • vrf - Virtual Routing Forwarding ID. type: int more...
    • embed-measured-health - Enable/disable embedding measured health information. type: str choices: [disable, enable] more...
    • sla-id-redistribute - Select the ID from the SLA sub-table. type: int more...
    • class-id - Traffic class ID. type: str more...
    • source6 - Source IPv6 addressused in the health-check packet to server. type: str more...

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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.