Try SpotterSD-WAN status checking or health checking.
| "added in version" 2.1.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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
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>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
wanprof:
description: The parameter (wanprof) in requested url.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
wanprof_system_sdwan_healthcheck:
description: The top level parameters set.
required: false
suboptions:
_dynamic-server:
description: Deprecated, please rename it to _dynamic_server.
type: str
addr-mode:
choices:
- ipv4
- ipv6
description: Deprecated, please rename it to addr_mode. Address mode
type: str
class-id:
description: Deprecated, please rename it to class_id. Traffic class ID.
type: str
detect-mode:
choices:
- active
- passive
- prefer-passive
- remote
- agent-based
description: Deprecated, please rename it to detect_mode. The mode determining
how to detect the server.
type: str
diffservcode:
description: Differentiated services code point
type: str
dns-match-ip:
description: Deprecated, please rename it to dns_match_ip. Response IP expected
from DNS server if the protocol is DNS.
type: str
dns-request-domain:
description: Deprecated, please rename it to dns_request_domain. Fully qualified
domain name to resolve for the DNS probe.
type: str
embed-measured-health:
choices:
- disable
- enable
description: Deprecated, please rename it to embed_measured_health. Enable/disable
embedding measured health information.
type: str
failtime:
description: Number of failures before server is considered lost
type: int
ftp-file:
description: Deprecated, please rename it to ftp_file. Full path and file name
on the FTP server to download for FTP health-check to probe.
type: str
ftp-mode:
choices:
- passive
- port
description: Deprecated, please rename it to ftp_mode. FTP mode.
type: str
ha-priority:
description: Deprecated, please rename it to ha_priority. HA election priority
type: int
http-agent:
description: Deprecated, please rename it to http_agent. String in the http-agent
field in the HTTP header.
type: str
http-get:
description: Deprecated, please rename it to http_get. URL used to communicate
with the server if the protocol if the protocol is HTTP.
type: str
http-match:
description: Deprecated, please rename it to http_match. Response string expected
from the server if the protocol is HTTP.
type: str
interval:
description: Status check interval in milliseconds, or the time between attempting
to connect to the server
type: int
members:
description: (list or str) Member sequence number list.
type: raw
mos-codec:
choices:
- g711
- g722
- g729
description: Deprecated, please rename it to mos_codec. Codec to use for MOS calculation
type: str
name:
description: Status check or health check name.
required: true
type: str
packet-size:
description: Deprecated, please rename it to packet_size. Packet size of a twamp
test session,
type: int
password:
description: (list) No description.
type: raw
port:
description: Port number used to communicate with the server over the selected
protocol
type: int
probe-count:
description: Deprecated, please rename it to probe_count. Number of most recent
probes that should be used to calculate latency and jitter
type: int
probe-packets:
choices:
- disable
- enable
description: Deprecated, please rename it to probe_packets. Enable/disable transmission
of probe packets.
type: str
probe-timeout:
description: Deprecated, please rename it to probe_timeout. Time to wait before
a probe packet is considered lost
type: int
protocol:
choices:
- ping
- tcp-echo
- udp-echo
- http
- twamp
- ping6
- dns
- tcp-connect
- ftp
- https
description: Protocol used to determine if the FortiGate can communicate with
the server.
type: str
quality-measured-method:
choices:
- half-close
- half-open
description: Deprecated, please rename it to quality_measured_method. Method to
measure the quality of tcp-connect.
type: str
recoverytime:
description: Number of successful responses received before server is considered
recovered
type: int
security-mode:
choices:
- none
- authentication
description: Deprecated, please rename it to security_mode. Twamp controller security
mode.
type: str
server:
description: (list) No description.
type: raw
sla:
description: No description.
elements: dict
suboptions:
id:
description: SLA ID.
type: int
jitter-threshold:
description: Deprecated, please rename it to jitter_threshold. Jitter for
SLA to make decision in milliseconds.
type: int
latency-threshold:
description: Deprecated, please rename it to latency_threshold. Latency for
SLA to make decision in milliseconds.
type: int
link-cost-factor:
choices:
- latency
- jitter
- packet-loss
- mos
description: Deprecated, please rename it to link_cost_factor.
elements: str
type: list
mos-threshold:
description: Deprecated, please rename it to mos_threshold. Minimum Mean Opinion
Score for SLA to be marked as pass.
type: str
packetloss-threshold:
description: Deprecated, please rename it to packetloss_threshold. Packet
loss for SLA to make decision in percentage.
type: int
priority-in-sla:
description: Deprecated, please rename it to priority_in_sla. Value to be
distributed into routing table when in-sla
type: int
priority-out-sla:
description: Deprecated, please rename it to priority_out_sla. Value to be
distributed into routing table when out-sla
type: int
type: list
sla-fail-log-period:
description: Deprecated, please rename it to sla_fail_log_period. Time interval
in seconds that SLA fail log messages will be generated
type: int
sla-id-redistribute:
description: Deprecated, please rename it to sla_id_redistribute. Select the ID
from the SLA sub-table.
type: int
sla-pass-log-period:
description: Deprecated, please rename it to sla_pass_log_period. Time interval
in seconds that SLA pass log messages will be generated
type: int
source:
description: Source IP address used in the health-check packet to the server.
type: str
source6:
description: Source IPv6 addressused in the health-check packet to server.
type: str
system-dns:
choices:
- disable
- enable
description: Deprecated, please rename it to system_dns. Enable/disable system
DNS as the probe server.
type: str
threshold-alert-jitter:
description: Deprecated, please rename it to threshold_alert_jitter. Alert threshold
for jitter
type: int
threshold-alert-latency:
description: Deprecated, please rename it to threshold_alert_latency. Alert threshold
for latency
type: int
threshold-alert-packetloss:
description: Deprecated, please rename it to threshold_alert_packetloss. Alert
threshold for packet loss
type: int
threshold-warning-jitter:
description: Deprecated, please rename it to threshold_warning_jitter. Warning
threshold for jitter
type: int
threshold-warning-latency:
description: Deprecated, please rename it to threshold_warning_latency. Warning
threshold for latency
type: int
threshold-warning-packetloss:
description: Deprecated, please rename it to threshold_warning_packetloss. Warning
threshold for packet loss
type: int
update-cascade-interface:
choices:
- disable
- enable
description: Deprecated, please rename it to update_cascade_interface. Enable/disable
update cascade interface.
type: str
update-static-route:
choices:
- disable
- enable
description: Deprecated, please rename it to update_static_route. Enable/disable
updating the static route.
type: str
user:
description: The user name to access probe server.
type: str
vrf:
description: Virtual Routing Forwarding ID.
type: int
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list