1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. WantempSystemVirtualwanlinkHealthcheck
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.WantempSystemVirtualwanlinkHealthcheck

Explore with Pulumi AI

SD-WAN status checking or health checking. Identify a server on the Internet and determine how SD-WAN verifies that the FortiGate can communicate with it.

This resource is a sub resource for variable health_check of resource fortimanager.WantempSystemVirtualwanlink. Conflict and overwrite may occur if use both of them. The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

  • sla: fortimanager.WantempSystemVirtualwanlinkHealthcheckSla

Create WantempSystemVirtualwanlinkHealthcheck Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WantempSystemVirtualwanlinkHealthcheck(name: string, args: WantempSystemVirtualwanlinkHealthcheckArgs, opts?: CustomResourceOptions);
@overload
def WantempSystemVirtualwanlinkHealthcheck(resource_name: str,
                                           args: WantempSystemVirtualwanlinkHealthcheckArgs,
                                           opts: Optional[ResourceOptions] = None)

@overload
def WantempSystemVirtualwanlinkHealthcheck(resource_name: str,
                                           opts: Optional[ResourceOptions] = None,
                                           wanprof: Optional[str] = None,
                                           probe_timeout: Optional[float] = None,
                                           adom: Optional[str] = None,
                                           diffservcode: Optional[str] = None,
                                           dynamic_sort_subtable: Optional[str] = None,
                                           failtime: Optional[float] = None,
                                           ha_priority: Optional[float] = None,
                                           http_agent: Optional[str] = None,
                                           http_get: Optional[str] = None,
                                           http_match: Optional[str] = None,
                                           internet_service_id: Optional[str] = None,
                                           interval: Optional[float] = None,
                                           members: Optional[str] = None,
                                           name: Optional[str] = None,
                                           packet_size: Optional[float] = None,
                                           passwords: Optional[Sequence[str]] = None,
                                           port: Optional[float] = None,
                                           _dynamic_server: Optional[str] = None,
                                           probe_packets: Optional[str] = None,
                                           threshold_alert_packetloss: Optional[float] = None,
                                           recoverytime: Optional[float] = None,
                                           scopetype: Optional[str] = None,
                                           security_mode: Optional[str] = None,
                                           servers: Optional[Sequence[str]] = None,
                                           sla_fail_log_period: Optional[float] = None,
                                           sla_pass_log_period: Optional[float] = None,
                                           slas: Optional[Sequence[WantempSystemVirtualwanlinkHealthcheckSlaArgs]] = None,
                                           threshold_alert_jitter: Optional[float] = None,
                                           threshold_alert_latency: Optional[float] = None,
                                           protocol: Optional[str] = None,
                                           threshold_warning_jitter: Optional[float] = None,
                                           threshold_warning_latency: Optional[float] = None,
                                           threshold_warning_packetloss: Optional[float] = None,
                                           update_cascade_interface: Optional[str] = None,
                                           update_static_route: Optional[str] = None,
                                           addr_mode: Optional[str] = None,
                                           wantemp_system_virtualwanlink_healthcheck_id: Optional[str] = None)
func NewWantempSystemVirtualwanlinkHealthcheck(ctx *Context, name string, args WantempSystemVirtualwanlinkHealthcheckArgs, opts ...ResourceOption) (*WantempSystemVirtualwanlinkHealthcheck, error)
public WantempSystemVirtualwanlinkHealthcheck(string name, WantempSystemVirtualwanlinkHealthcheckArgs args, CustomResourceOptions? opts = null)
public WantempSystemVirtualwanlinkHealthcheck(String name, WantempSystemVirtualwanlinkHealthcheckArgs args)
public WantempSystemVirtualwanlinkHealthcheck(String name, WantempSystemVirtualwanlinkHealthcheckArgs args, CustomResourceOptions options)
type: fortimanager:WantempSystemVirtualwanlinkHealthcheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WantempSystemVirtualwanlinkHealthcheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WantempSystemVirtualwanlinkHealthcheckArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WantempSystemVirtualwanlinkHealthcheckArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WantempSystemVirtualwanlinkHealthcheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WantempSystemVirtualwanlinkHealthcheckArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var wantempSystemVirtualwanlinkHealthcheckResource = new Fortimanager.WantempSystemVirtualwanlinkHealthcheck("wantempSystemVirtualwanlinkHealthcheckResource", new()
{
    Wanprof = "string",
    ProbeTimeout = 0,
    Adom = "string",
    Diffservcode = "string",
    DynamicSortSubtable = "string",
    Failtime = 0,
    HaPriority = 0,
    HttpAgent = "string",
    HttpGet = "string",
    HttpMatch = "string",
    InternetServiceId = "string",
    Interval = 0,
    Members = "string",
    Name = "string",
    PacketSize = 0,
    Passwords = new[]
    {
        "string",
    },
    Port = 0,
    _dynamicServer = "string",
    ProbePackets = "string",
    ThresholdAlertPacketloss = 0,
    Recoverytime = 0,
    Scopetype = "string",
    SecurityMode = "string",
    Servers = new[]
    {
        "string",
    },
    SlaFailLogPeriod = 0,
    SlaPassLogPeriod = 0,
    Slas = new[]
    {
        new Fortimanager.Inputs.WantempSystemVirtualwanlinkHealthcheckSlaArgs
        {
            Id = 0,
            JitterThreshold = 0,
            LatencyThreshold = 0,
            LinkCostFactors = new[]
            {
                "string",
            },
            PacketlossThreshold = 0,
        },
    },
    ThresholdAlertJitter = 0,
    ThresholdAlertLatency = 0,
    Protocol = "string",
    ThresholdWarningJitter = 0,
    ThresholdWarningLatency = 0,
    ThresholdWarningPacketloss = 0,
    UpdateCascadeInterface = "string",
    UpdateStaticRoute = "string",
    AddrMode = "string",
    WantempSystemVirtualwanlinkHealthcheckId = "string",
});
Copy
example, err := fortimanager.NewWantempSystemVirtualwanlinkHealthcheck(ctx, "wantempSystemVirtualwanlinkHealthcheckResource", &fortimanager.WantempSystemVirtualwanlinkHealthcheckArgs{
Wanprof: pulumi.String("string"),
ProbeTimeout: pulumi.Float64(0),
Adom: pulumi.String("string"),
Diffservcode: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
Failtime: pulumi.Float64(0),
HaPriority: pulumi.Float64(0),
HttpAgent: pulumi.String("string"),
HttpGet: pulumi.String("string"),
HttpMatch: pulumi.String("string"),
InternetServiceId: pulumi.String("string"),
Interval: pulumi.Float64(0),
Members: pulumi.String("string"),
Name: pulumi.String("string"),
PacketSize: pulumi.Float64(0),
Passwords: pulumi.StringArray{
pulumi.String("string"),
},
Port: pulumi.Float64(0),
_dynamicServer: pulumi.String("string"),
ProbePackets: pulumi.String("string"),
ThresholdAlertPacketloss: pulumi.Float64(0),
Recoverytime: pulumi.Float64(0),
Scopetype: pulumi.String("string"),
SecurityMode: pulumi.String("string"),
Servers: pulumi.StringArray{
pulumi.String("string"),
},
SlaFailLogPeriod: pulumi.Float64(0),
SlaPassLogPeriod: pulumi.Float64(0),
Slas: .WantempSystemVirtualwanlinkHealthcheckSlaTypeArray{
&.WantempSystemVirtualwanlinkHealthcheckSlaTypeArgs{
Id: pulumi.Float64(0),
JitterThreshold: pulumi.Float64(0),
LatencyThreshold: pulumi.Float64(0),
LinkCostFactors: pulumi.StringArray{
pulumi.String("string"),
},
PacketlossThreshold: pulumi.Float64(0),
},
},
ThresholdAlertJitter: pulumi.Float64(0),
ThresholdAlertLatency: pulumi.Float64(0),
Protocol: pulumi.String("string"),
ThresholdWarningJitter: pulumi.Float64(0),
ThresholdWarningLatency: pulumi.Float64(0),
ThresholdWarningPacketloss: pulumi.Float64(0),
UpdateCascadeInterface: pulumi.String("string"),
UpdateStaticRoute: pulumi.String("string"),
AddrMode: pulumi.String("string"),
WantempSystemVirtualwanlinkHealthcheckId: pulumi.String("string"),
})
Copy
var wantempSystemVirtualwanlinkHealthcheckResource = new WantempSystemVirtualwanlinkHealthcheck("wantempSystemVirtualwanlinkHealthcheckResource", WantempSystemVirtualwanlinkHealthcheckArgs.builder()
    .wanprof("string")
    .probeTimeout(0)
    .adom("string")
    .diffservcode("string")
    .dynamicSortSubtable("string")
    .failtime(0)
    .haPriority(0)
    .httpAgent("string")
    .httpGet("string")
    .httpMatch("string")
    .internetServiceId("string")
    .interval(0)
    .members("string")
    .name("string")
    .packetSize(0)
    .passwords("string")
    .port(0)
    ._dynamicServer("string")
    .probePackets("string")
    .thresholdAlertPacketloss(0)
    .recoverytime(0)
    .scopetype("string")
    .securityMode("string")
    .servers("string")
    .slaFailLogPeriod(0)
    .slaPassLogPeriod(0)
    .slas(WantempSystemVirtualwanlinkHealthcheckSlaArgs.builder()
        .id(0)
        .jitterThreshold(0)
        .latencyThreshold(0)
        .linkCostFactors("string")
        .packetlossThreshold(0)
        .build())
    .thresholdAlertJitter(0)
    .thresholdAlertLatency(0)
    .protocol("string")
    .thresholdWarningJitter(0)
    .thresholdWarningLatency(0)
    .thresholdWarningPacketloss(0)
    .updateCascadeInterface("string")
    .updateStaticRoute("string")
    .addrMode("string")
    .wantempSystemVirtualwanlinkHealthcheckId("string")
    .build());
Copy
wantemp_system_virtualwanlink_healthcheck_resource = fortimanager.WantempSystemVirtualwanlinkHealthcheck("wantempSystemVirtualwanlinkHealthcheckResource",
    wanprof="string",
    probe_timeout=0,
    adom="string",
    diffservcode="string",
    dynamic_sort_subtable="string",
    failtime=0,
    ha_priority=0,
    http_agent="string",
    http_get="string",
    http_match="string",
    internet_service_id="string",
    interval=0,
    members="string",
    name="string",
    packet_size=0,
    passwords=["string"],
    port=0,
    _dynamic_server="string",
    probe_packets="string",
    threshold_alert_packetloss=0,
    recoverytime=0,
    scopetype="string",
    security_mode="string",
    servers=["string"],
    sla_fail_log_period=0,
    sla_pass_log_period=0,
    slas=[{
        "id": 0,
        "jitter_threshold": 0,
        "latency_threshold": 0,
        "link_cost_factors": ["string"],
        "packetloss_threshold": 0,
    }],
    threshold_alert_jitter=0,
    threshold_alert_latency=0,
    protocol="string",
    threshold_warning_jitter=0,
    threshold_warning_latency=0,
    threshold_warning_packetloss=0,
    update_cascade_interface="string",
    update_static_route="string",
    addr_mode="string",
    wantemp_system_virtualwanlink_healthcheck_id="string")
Copy
const wantempSystemVirtualwanlinkHealthcheckResource = new fortimanager.WantempSystemVirtualwanlinkHealthcheck("wantempSystemVirtualwanlinkHealthcheckResource", {
    wanprof: "string",
    probeTimeout: 0,
    adom: "string",
    diffservcode: "string",
    dynamicSortSubtable: "string",
    failtime: 0,
    haPriority: 0,
    httpAgent: "string",
    httpGet: "string",
    httpMatch: "string",
    internetServiceId: "string",
    interval: 0,
    members: "string",
    name: "string",
    packetSize: 0,
    passwords: ["string"],
    port: 0,
    _dynamicServer: "string",
    probePackets: "string",
    thresholdAlertPacketloss: 0,
    recoverytime: 0,
    scopetype: "string",
    securityMode: "string",
    servers: ["string"],
    slaFailLogPeriod: 0,
    slaPassLogPeriod: 0,
    slas: [{
        id: 0,
        jitterThreshold: 0,
        latencyThreshold: 0,
        linkCostFactors: ["string"],
        packetlossThreshold: 0,
    }],
    thresholdAlertJitter: 0,
    thresholdAlertLatency: 0,
    protocol: "string",
    thresholdWarningJitter: 0,
    thresholdWarningLatency: 0,
    thresholdWarningPacketloss: 0,
    updateCascadeInterface: "string",
    updateStaticRoute: "string",
    addrMode: "string",
    wantempSystemVirtualwanlinkHealthcheckId: "string",
});
Copy
type: fortimanager:WantempSystemVirtualwanlinkHealthcheck
properties:
    _dynamicServer: string
    addrMode: string
    adom: string
    diffservcode: string
    dynamicSortSubtable: string
    failtime: 0
    haPriority: 0
    httpAgent: string
    httpGet: string
    httpMatch: string
    internetServiceId: string
    interval: 0
    members: string
    name: string
    packetSize: 0
    passwords:
        - string
    port: 0
    probePackets: string
    probeTimeout: 0
    protocol: string
    recoverytime: 0
    scopetype: string
    securityMode: string
    servers:
        - string
    slaFailLogPeriod: 0
    slaPassLogPeriod: 0
    slas:
        - id: 0
          jitterThreshold: 0
          latencyThreshold: 0
          linkCostFactors:
            - string
          packetlossThreshold: 0
    thresholdAlertJitter: 0
    thresholdAlertLatency: 0
    thresholdAlertPacketloss: 0
    thresholdWarningJitter: 0
    thresholdWarningLatency: 0
    thresholdWarningPacketloss: 0
    updateCascadeInterface: string
    updateStaticRoute: string
    wanprof: string
    wantempSystemVirtualwanlinkHealthcheckId: string
Copy

WantempSystemVirtualwanlinkHealthcheck Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WantempSystemVirtualwanlinkHealthcheck resource accepts the following input properties:

Wanprof This property is required. string
Wanprof.
AddrMode string
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Failtime double
Number of failures before server is considered lost (1 - 3600, default = 5).
HaPriority double
HA election priority (1 - 50).
HttpAgent string
String in the http-agent field in the HTTP header.
HttpGet string
URL used to communicate with the server if the protocol if the protocol is HTTP.
HttpMatch string
Response string expected from the server if the protocol is HTTP.
InternetServiceId string
Internet-Service-Id.
Interval double
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
Members string
Member sequence number list.
Name string
Status check or health check name.
PacketSize double
Packet size of a twamp test session,
Passwords List<string>
Twamp controller password in authentication mode
Port double
Port number used to communicate with the server over the selected protocol.
ProbePackets string
Enable/disable transmission of probe packets. Valid values: disable, enable.
ProbeTimeout double
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
Protocol string
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
Recoverytime double
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
SecurityMode string
Twamp controller security mode. Valid values: none, authentication.
Servers List<string>
IP address or FQDN name of the server.
SlaFailLogPeriod double
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
SlaPassLogPeriod double
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
Slas List<WantempSystemVirtualwanlinkHealthcheckSla>
Sla. The structure of sla block is documented below.
ThresholdAlertJitter double
Alert threshold for jitter (ms, default = 0).
ThresholdAlertLatency double
Alert threshold for latency (ms, default = 0).
ThresholdAlertPacketloss double
Alert threshold for packet loss (percentage, default = 0).
ThresholdWarningJitter double
Warning threshold for jitter (ms, default = 0).
ThresholdWarningLatency double
Warning threshold for latency (ms, default = 0).
ThresholdWarningPacketloss double
Warning threshold for packet loss (percentage, default = 0).
UpdateCascadeInterface string
Enable/disable update cascade interface. Valid values: disable, enable.
UpdateStaticRoute string
Enable/disable updating the static route. Valid values: disable, enable.
WantempSystemVirtualwanlinkHealthcheckId string
an identifier for the resource with format {{name}}.
_dynamicServer string
_Dynamic-Server.
Wanprof This property is required. string
Wanprof.
AddrMode string
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Failtime float64
Number of failures before server is considered lost (1 - 3600, default = 5).
HaPriority float64
HA election priority (1 - 50).
HttpAgent string
String in the http-agent field in the HTTP header.
HttpGet string
URL used to communicate with the server if the protocol if the protocol is HTTP.
HttpMatch string
Response string expected from the server if the protocol is HTTP.
InternetServiceId string
Internet-Service-Id.
Interval float64
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
Members string
Member sequence number list.
Name string
Status check or health check name.
PacketSize float64
Packet size of a twamp test session,
Passwords []string
Twamp controller password in authentication mode
Port float64
Port number used to communicate with the server over the selected protocol.
ProbePackets string
Enable/disable transmission of probe packets. Valid values: disable, enable.
ProbeTimeout float64
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
Protocol string
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
Recoverytime float64
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
SecurityMode string
Twamp controller security mode. Valid values: none, authentication.
Servers []string
IP address or FQDN name of the server.
SlaFailLogPeriod float64
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
SlaPassLogPeriod float64
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
Slas []WantempSystemVirtualwanlinkHealthcheckSlaTypeArgs
Sla. The structure of sla block is documented below.
ThresholdAlertJitter float64
Alert threshold for jitter (ms, default = 0).
ThresholdAlertLatency float64
Alert threshold for latency (ms, default = 0).
ThresholdAlertPacketloss float64
Alert threshold for packet loss (percentage, default = 0).
ThresholdWarningJitter float64
Warning threshold for jitter (ms, default = 0).
ThresholdWarningLatency float64
Warning threshold for latency (ms, default = 0).
ThresholdWarningPacketloss float64
Warning threshold for packet loss (percentage, default = 0).
UpdateCascadeInterface string
Enable/disable update cascade interface. Valid values: disable, enable.
UpdateStaticRoute string
Enable/disable updating the static route. Valid values: disable, enable.
WantempSystemVirtualwanlinkHealthcheckId string
an identifier for the resource with format {{name}}.
_dynamicServer string
_Dynamic-Server.
wanprof This property is required. String
Wanprof.
_dynamicServer String
_Dynamic-Server.
addrMode String
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
diffservcode String
Differentiated services code point (DSCP) in the IP header of the probe packet.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
failtime Double
Number of failures before server is considered lost (1 - 3600, default = 5).
haPriority Double
HA election priority (1 - 50).
httpAgent String
String in the http-agent field in the HTTP header.
httpGet String
URL used to communicate with the server if the protocol if the protocol is HTTP.
httpMatch String
Response string expected from the server if the protocol is HTTP.
internetServiceId String
Internet-Service-Id.
interval Double
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members String
Member sequence number list.
name String
Status check or health check name.
packetSize Double
Packet size of a twamp test session,
passwords List<String>
Twamp controller password in authentication mode
port Double
Port number used to communicate with the server over the selected protocol.
probePackets String
Enable/disable transmission of probe packets. Valid values: disable, enable.
probeTimeout Double
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
protocol String
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
recoverytime Double
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
securityMode String
Twamp controller security mode. Valid values: none, authentication.
servers List<String>
IP address or FQDN name of the server.
slaFailLogPeriod Double
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
slaPassLogPeriod Double
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas List<WantempSystemVirtualwanlinkHealthcheckSla>
Sla. The structure of sla block is documented below.
thresholdAlertJitter Double
Alert threshold for jitter (ms, default = 0).
thresholdAlertLatency Double
Alert threshold for latency (ms, default = 0).
thresholdAlertPacketloss Double
Alert threshold for packet loss (percentage, default = 0).
thresholdWarningJitter Double
Warning threshold for jitter (ms, default = 0).
thresholdWarningLatency Double
Warning threshold for latency (ms, default = 0).
thresholdWarningPacketloss Double
Warning threshold for packet loss (percentage, default = 0).
updateCascadeInterface String
Enable/disable update cascade interface. Valid values: disable, enable.
updateStaticRoute String
Enable/disable updating the static route. Valid values: disable, enable.
wantempSystemVirtualwanlinkHealthcheckId String
an identifier for the resource with format {{name}}.
wanprof This property is required. string
Wanprof.
_dynamicServer string
_Dynamic-Server.
addrMode string
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
failtime number
Number of failures before server is considered lost (1 - 3600, default = 5).
haPriority number
HA election priority (1 - 50).
httpAgent string
String in the http-agent field in the HTTP header.
httpGet string
URL used to communicate with the server if the protocol if the protocol is HTTP.
httpMatch string
Response string expected from the server if the protocol is HTTP.
internetServiceId string
Internet-Service-Id.
interval number
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members string
Member sequence number list.
name string
Status check or health check name.
packetSize number
Packet size of a twamp test session,
passwords string[]
Twamp controller password in authentication mode
port number
Port number used to communicate with the server over the selected protocol.
probePackets string
Enable/disable transmission of probe packets. Valid values: disable, enable.
probeTimeout number
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
protocol string
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
recoverytime number
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
securityMode string
Twamp controller security mode. Valid values: none, authentication.
servers string[]
IP address or FQDN name of the server.
slaFailLogPeriod number
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
slaPassLogPeriod number
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas WantempSystemVirtualwanlinkHealthcheckSla[]
Sla. The structure of sla block is documented below.
thresholdAlertJitter number
Alert threshold for jitter (ms, default = 0).
thresholdAlertLatency number
Alert threshold for latency (ms, default = 0).
thresholdAlertPacketloss number
Alert threshold for packet loss (percentage, default = 0).
thresholdWarningJitter number
Warning threshold for jitter (ms, default = 0).
thresholdWarningLatency number
Warning threshold for latency (ms, default = 0).
thresholdWarningPacketloss number
Warning threshold for packet loss (percentage, default = 0).
updateCascadeInterface string
Enable/disable update cascade interface. Valid values: disable, enable.
updateStaticRoute string
Enable/disable updating the static route. Valid values: disable, enable.
wantempSystemVirtualwanlinkHealthcheckId string
an identifier for the resource with format {{name}}.
wanprof This property is required. str
Wanprof.
_dynamic_server str
_Dynamic-Server.
addr_mode str
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
diffservcode str
Differentiated services code point (DSCP) in the IP header of the probe packet.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
failtime float
Number of failures before server is considered lost (1 - 3600, default = 5).
ha_priority float
HA election priority (1 - 50).
http_agent str
String in the http-agent field in the HTTP header.
http_get str
URL used to communicate with the server if the protocol if the protocol is HTTP.
http_match str
Response string expected from the server if the protocol is HTTP.
internet_service_id str
Internet-Service-Id.
interval float
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members str
Member sequence number list.
name str
Status check or health check name.
packet_size float
Packet size of a twamp test session,
passwords Sequence[str]
Twamp controller password in authentication mode
port float
Port number used to communicate with the server over the selected protocol.
probe_packets str
Enable/disable transmission of probe packets. Valid values: disable, enable.
probe_timeout float
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
protocol str
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
recoverytime float
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
scopetype str
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
security_mode str
Twamp controller security mode. Valid values: none, authentication.
servers Sequence[str]
IP address or FQDN name of the server.
sla_fail_log_period float
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
sla_pass_log_period float
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas Sequence[WantempSystemVirtualwanlinkHealthcheckSlaArgs]
Sla. The structure of sla block is documented below.
threshold_alert_jitter float
Alert threshold for jitter (ms, default = 0).
threshold_alert_latency float
Alert threshold for latency (ms, default = 0).
threshold_alert_packetloss float
Alert threshold for packet loss (percentage, default = 0).
threshold_warning_jitter float
Warning threshold for jitter (ms, default = 0).
threshold_warning_latency float
Warning threshold for latency (ms, default = 0).
threshold_warning_packetloss float
Warning threshold for packet loss (percentage, default = 0).
update_cascade_interface str
Enable/disable update cascade interface. Valid values: disable, enable.
update_static_route str
Enable/disable updating the static route. Valid values: disable, enable.
wantemp_system_virtualwanlink_healthcheck_id str
an identifier for the resource with format {{name}}.
wanprof This property is required. String
Wanprof.
_dynamicServer String
_Dynamic-Server.
addrMode String
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
diffservcode String
Differentiated services code point (DSCP) in the IP header of the probe packet.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
failtime Number
Number of failures before server is considered lost (1 - 3600, default = 5).
haPriority Number
HA election priority (1 - 50).
httpAgent String
String in the http-agent field in the HTTP header.
httpGet String
URL used to communicate with the server if the protocol if the protocol is HTTP.
httpMatch String
Response string expected from the server if the protocol is HTTP.
internetServiceId String
Internet-Service-Id.
interval Number
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members String
Member sequence number list.
name String
Status check or health check name.
packetSize Number
Packet size of a twamp test session,
passwords List<String>
Twamp controller password in authentication mode
port Number
Port number used to communicate with the server over the selected protocol.
probePackets String
Enable/disable transmission of probe packets. Valid values: disable, enable.
probeTimeout Number
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
protocol String
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
recoverytime Number
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
securityMode String
Twamp controller security mode. Valid values: none, authentication.
servers List<String>
IP address or FQDN name of the server.
slaFailLogPeriod Number
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
slaPassLogPeriod Number
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas List<Property Map>
Sla. The structure of sla block is documented below.
thresholdAlertJitter Number
Alert threshold for jitter (ms, default = 0).
thresholdAlertLatency Number
Alert threshold for latency (ms, default = 0).
thresholdAlertPacketloss Number
Alert threshold for packet loss (percentage, default = 0).
thresholdWarningJitter Number
Warning threshold for jitter (ms, default = 0).
thresholdWarningLatency Number
Warning threshold for latency (ms, default = 0).
thresholdWarningPacketloss Number
Warning threshold for packet loss (percentage, default = 0).
updateCascadeInterface String
Enable/disable update cascade interface. Valid values: disable, enable.
updateStaticRoute String
Enable/disable updating the static route. Valid values: disable, enable.
wantempSystemVirtualwanlinkHealthcheckId String
an identifier for the resource with format {{name}}.

Outputs

All input properties are implicitly available as output properties. Additionally, the WantempSystemVirtualwanlinkHealthcheck resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing WantempSystemVirtualwanlinkHealthcheck Resource

Get an existing WantempSystemVirtualwanlinkHealthcheck resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: WantempSystemVirtualwanlinkHealthcheckState, opts?: CustomResourceOptions): WantempSystemVirtualwanlinkHealthcheck
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        _dynamic_server: Optional[str] = None,
        addr_mode: Optional[str] = None,
        adom: Optional[str] = None,
        diffservcode: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        failtime: Optional[float] = None,
        ha_priority: Optional[float] = None,
        http_agent: Optional[str] = None,
        http_get: Optional[str] = None,
        http_match: Optional[str] = None,
        internet_service_id: Optional[str] = None,
        interval: Optional[float] = None,
        members: Optional[str] = None,
        name: Optional[str] = None,
        packet_size: Optional[float] = None,
        passwords: Optional[Sequence[str]] = None,
        port: Optional[float] = None,
        probe_packets: Optional[str] = None,
        probe_timeout: Optional[float] = None,
        protocol: Optional[str] = None,
        recoverytime: Optional[float] = None,
        scopetype: Optional[str] = None,
        security_mode: Optional[str] = None,
        servers: Optional[Sequence[str]] = None,
        sla_fail_log_period: Optional[float] = None,
        sla_pass_log_period: Optional[float] = None,
        slas: Optional[Sequence[WantempSystemVirtualwanlinkHealthcheckSlaArgs]] = None,
        threshold_alert_jitter: Optional[float] = None,
        threshold_alert_latency: Optional[float] = None,
        threshold_alert_packetloss: Optional[float] = None,
        threshold_warning_jitter: Optional[float] = None,
        threshold_warning_latency: Optional[float] = None,
        threshold_warning_packetloss: Optional[float] = None,
        update_cascade_interface: Optional[str] = None,
        update_static_route: Optional[str] = None,
        wanprof: Optional[str] = None,
        wantemp_system_virtualwanlink_healthcheck_id: Optional[str] = None) -> WantempSystemVirtualwanlinkHealthcheck
func GetWantempSystemVirtualwanlinkHealthcheck(ctx *Context, name string, id IDInput, state *WantempSystemVirtualwanlinkHealthcheckState, opts ...ResourceOption) (*WantempSystemVirtualwanlinkHealthcheck, error)
public static WantempSystemVirtualwanlinkHealthcheck Get(string name, Input<string> id, WantempSystemVirtualwanlinkHealthcheckState? state, CustomResourceOptions? opts = null)
public static WantempSystemVirtualwanlinkHealthcheck get(String name, Output<String> id, WantempSystemVirtualwanlinkHealthcheckState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:WantempSystemVirtualwanlinkHealthcheck    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AddrMode string
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Failtime double
Number of failures before server is considered lost (1 - 3600, default = 5).
HaPriority double
HA election priority (1 - 50).
HttpAgent string
String in the http-agent field in the HTTP header.
HttpGet string
URL used to communicate with the server if the protocol if the protocol is HTTP.
HttpMatch string
Response string expected from the server if the protocol is HTTP.
InternetServiceId string
Internet-Service-Id.
Interval double
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
Members string
Member sequence number list.
Name string
Status check or health check name.
PacketSize double
Packet size of a twamp test session,
Passwords List<string>
Twamp controller password in authentication mode
Port double
Port number used to communicate with the server over the selected protocol.
ProbePackets string
Enable/disable transmission of probe packets. Valid values: disable, enable.
ProbeTimeout double
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
Protocol string
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
Recoverytime double
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
SecurityMode string
Twamp controller security mode. Valid values: none, authentication.
Servers List<string>
IP address or FQDN name of the server.
SlaFailLogPeriod double
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
SlaPassLogPeriod double
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
Slas List<WantempSystemVirtualwanlinkHealthcheckSla>
Sla. The structure of sla block is documented below.
ThresholdAlertJitter double
Alert threshold for jitter (ms, default = 0).
ThresholdAlertLatency double
Alert threshold for latency (ms, default = 0).
ThresholdAlertPacketloss double
Alert threshold for packet loss (percentage, default = 0).
ThresholdWarningJitter double
Warning threshold for jitter (ms, default = 0).
ThresholdWarningLatency double
Warning threshold for latency (ms, default = 0).
ThresholdWarningPacketloss double
Warning threshold for packet loss (percentage, default = 0).
UpdateCascadeInterface string
Enable/disable update cascade interface. Valid values: disable, enable.
UpdateStaticRoute string
Enable/disable updating the static route. Valid values: disable, enable.
Wanprof string
Wanprof.
WantempSystemVirtualwanlinkHealthcheckId string
an identifier for the resource with format {{name}}.
_dynamicServer string
_Dynamic-Server.
AddrMode string
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Failtime float64
Number of failures before server is considered lost (1 - 3600, default = 5).
HaPriority float64
HA election priority (1 - 50).
HttpAgent string
String in the http-agent field in the HTTP header.
HttpGet string
URL used to communicate with the server if the protocol if the protocol is HTTP.
HttpMatch string
Response string expected from the server if the protocol is HTTP.
InternetServiceId string
Internet-Service-Id.
Interval float64
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
Members string
Member sequence number list.
Name string
Status check or health check name.
PacketSize float64
Packet size of a twamp test session,
Passwords []string
Twamp controller password in authentication mode
Port float64
Port number used to communicate with the server over the selected protocol.
ProbePackets string
Enable/disable transmission of probe packets. Valid values: disable, enable.
ProbeTimeout float64
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
Protocol string
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
Recoverytime float64
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
SecurityMode string
Twamp controller security mode. Valid values: none, authentication.
Servers []string
IP address or FQDN name of the server.
SlaFailLogPeriod float64
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
SlaPassLogPeriod float64
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
Slas []WantempSystemVirtualwanlinkHealthcheckSlaTypeArgs
Sla. The structure of sla block is documented below.
ThresholdAlertJitter float64
Alert threshold for jitter (ms, default = 0).
ThresholdAlertLatency float64
Alert threshold for latency (ms, default = 0).
ThresholdAlertPacketloss float64
Alert threshold for packet loss (percentage, default = 0).
ThresholdWarningJitter float64
Warning threshold for jitter (ms, default = 0).
ThresholdWarningLatency float64
Warning threshold for latency (ms, default = 0).
ThresholdWarningPacketloss float64
Warning threshold for packet loss (percentage, default = 0).
UpdateCascadeInterface string
Enable/disable update cascade interface. Valid values: disable, enable.
UpdateStaticRoute string
Enable/disable updating the static route. Valid values: disable, enable.
Wanprof string
Wanprof.
WantempSystemVirtualwanlinkHealthcheckId string
an identifier for the resource with format {{name}}.
_dynamicServer string
_Dynamic-Server.
_dynamicServer String
_Dynamic-Server.
addrMode String
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
diffservcode String
Differentiated services code point (DSCP) in the IP header of the probe packet.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
failtime Double
Number of failures before server is considered lost (1 - 3600, default = 5).
haPriority Double
HA election priority (1 - 50).
httpAgent String
String in the http-agent field in the HTTP header.
httpGet String
URL used to communicate with the server if the protocol if the protocol is HTTP.
httpMatch String
Response string expected from the server if the protocol is HTTP.
internetServiceId String
Internet-Service-Id.
interval Double
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members String
Member sequence number list.
name String
Status check or health check name.
packetSize Double
Packet size of a twamp test session,
passwords List<String>
Twamp controller password in authentication mode
port Double
Port number used to communicate with the server over the selected protocol.
probePackets String
Enable/disable transmission of probe packets. Valid values: disable, enable.
probeTimeout Double
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
protocol String
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
recoverytime Double
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
securityMode String
Twamp controller security mode. Valid values: none, authentication.
servers List<String>
IP address or FQDN name of the server.
slaFailLogPeriod Double
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
slaPassLogPeriod Double
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas List<WantempSystemVirtualwanlinkHealthcheckSla>
Sla. The structure of sla block is documented below.
thresholdAlertJitter Double
Alert threshold for jitter (ms, default = 0).
thresholdAlertLatency Double
Alert threshold for latency (ms, default = 0).
thresholdAlertPacketloss Double
Alert threshold for packet loss (percentage, default = 0).
thresholdWarningJitter Double
Warning threshold for jitter (ms, default = 0).
thresholdWarningLatency Double
Warning threshold for latency (ms, default = 0).
thresholdWarningPacketloss Double
Warning threshold for packet loss (percentage, default = 0).
updateCascadeInterface String
Enable/disable update cascade interface. Valid values: disable, enable.
updateStaticRoute String
Enable/disable updating the static route. Valid values: disable, enable.
wanprof String
Wanprof.
wantempSystemVirtualwanlinkHealthcheckId String
an identifier for the resource with format {{name}}.
_dynamicServer string
_Dynamic-Server.
addrMode string
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
failtime number
Number of failures before server is considered lost (1 - 3600, default = 5).
haPriority number
HA election priority (1 - 50).
httpAgent string
String in the http-agent field in the HTTP header.
httpGet string
URL used to communicate with the server if the protocol if the protocol is HTTP.
httpMatch string
Response string expected from the server if the protocol is HTTP.
internetServiceId string
Internet-Service-Id.
interval number
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members string
Member sequence number list.
name string
Status check or health check name.
packetSize number
Packet size of a twamp test session,
passwords string[]
Twamp controller password in authentication mode
port number
Port number used to communicate with the server over the selected protocol.
probePackets string
Enable/disable transmission of probe packets. Valid values: disable, enable.
probeTimeout number
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
protocol string
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
recoverytime number
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
securityMode string
Twamp controller security mode. Valid values: none, authentication.
servers string[]
IP address or FQDN name of the server.
slaFailLogPeriod number
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
slaPassLogPeriod number
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas WantempSystemVirtualwanlinkHealthcheckSla[]
Sla. The structure of sla block is documented below.
thresholdAlertJitter number
Alert threshold for jitter (ms, default = 0).
thresholdAlertLatency number
Alert threshold for latency (ms, default = 0).
thresholdAlertPacketloss number
Alert threshold for packet loss (percentage, default = 0).
thresholdWarningJitter number
Warning threshold for jitter (ms, default = 0).
thresholdWarningLatency number
Warning threshold for latency (ms, default = 0).
thresholdWarningPacketloss number
Warning threshold for packet loss (percentage, default = 0).
updateCascadeInterface string
Enable/disable update cascade interface. Valid values: disable, enable.
updateStaticRoute string
Enable/disable updating the static route. Valid values: disable, enable.
wanprof string
Wanprof.
wantempSystemVirtualwanlinkHealthcheckId string
an identifier for the resource with format {{name}}.
_dynamic_server str
_Dynamic-Server.
addr_mode str
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
diffservcode str
Differentiated services code point (DSCP) in the IP header of the probe packet.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
failtime float
Number of failures before server is considered lost (1 - 3600, default = 5).
ha_priority float
HA election priority (1 - 50).
http_agent str
String in the http-agent field in the HTTP header.
http_get str
URL used to communicate with the server if the protocol if the protocol is HTTP.
http_match str
Response string expected from the server if the protocol is HTTP.
internet_service_id str
Internet-Service-Id.
interval float
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members str
Member sequence number list.
name str
Status check or health check name.
packet_size float
Packet size of a twamp test session,
passwords Sequence[str]
Twamp controller password in authentication mode
port float
Port number used to communicate with the server over the selected protocol.
probe_packets str
Enable/disable transmission of probe packets. Valid values: disable, enable.
probe_timeout float
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
protocol str
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
recoverytime float
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
scopetype str
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
security_mode str
Twamp controller security mode. Valid values: none, authentication.
servers Sequence[str]
IP address or FQDN name of the server.
sla_fail_log_period float
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
sla_pass_log_period float
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas Sequence[WantempSystemVirtualwanlinkHealthcheckSlaArgs]
Sla. The structure of sla block is documented below.
threshold_alert_jitter float
Alert threshold for jitter (ms, default = 0).
threshold_alert_latency float
Alert threshold for latency (ms, default = 0).
threshold_alert_packetloss float
Alert threshold for packet loss (percentage, default = 0).
threshold_warning_jitter float
Warning threshold for jitter (ms, default = 0).
threshold_warning_latency float
Warning threshold for latency (ms, default = 0).
threshold_warning_packetloss float
Warning threshold for packet loss (percentage, default = 0).
update_cascade_interface str
Enable/disable update cascade interface. Valid values: disable, enable.
update_static_route str
Enable/disable updating the static route. Valid values: disable, enable.
wanprof str
Wanprof.
wantemp_system_virtualwanlink_healthcheck_id str
an identifier for the resource with format {{name}}.
_dynamicServer String
_Dynamic-Server.
addrMode String
Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
diffservcode String
Differentiated services code point (DSCP) in the IP header of the probe packet.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
failtime Number
Number of failures before server is considered lost (1 - 3600, default = 5).
haPriority Number
HA election priority (1 - 50).
httpAgent String
String in the http-agent field in the HTTP header.
httpGet String
URL used to communicate with the server if the protocol if the protocol is HTTP.
httpMatch String
Response string expected from the server if the protocol is HTTP.
internetServiceId String
Internet-Service-Id.
interval Number
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members String
Member sequence number list.
name String
Status check or health check name.
packetSize Number
Packet size of a twamp test session,
passwords List<String>
Twamp controller password in authentication mode
port Number
Port number used to communicate with the server over the selected protocol.
probePackets String
Enable/disable transmission of probe packets. Valid values: disable, enable.
probeTimeout Number
Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
protocol String
Protocol used to determine if the FortiGate can communicate with the server. Valid values: ping, tcp-echo, udp-echo, http, twamp, ping6, dns.
recoverytime Number
Number of successful responses received before server is considered recovered (1 - 3600, default = 5).
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
securityMode String
Twamp controller security mode. Valid values: none, authentication.
servers List<String>
IP address or FQDN name of the server.
slaFailLogPeriod Number
Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).
slaPassLogPeriod Number
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas List<Property Map>
Sla. The structure of sla block is documented below.
thresholdAlertJitter Number
Alert threshold for jitter (ms, default = 0).
thresholdAlertLatency Number
Alert threshold for latency (ms, default = 0).
thresholdAlertPacketloss Number
Alert threshold for packet loss (percentage, default = 0).
thresholdWarningJitter Number
Warning threshold for jitter (ms, default = 0).
thresholdWarningLatency Number
Warning threshold for latency (ms, default = 0).
thresholdWarningPacketloss Number
Warning threshold for packet loss (percentage, default = 0).
updateCascadeInterface String
Enable/disable update cascade interface. Valid values: disable, enable.
updateStaticRoute String
Enable/disable updating the static route. Valid values: disable, enable.
wanprof String
Wanprof.
wantempSystemVirtualwanlinkHealthcheckId String
an identifier for the resource with format {{name}}.

Supporting Types

WantempSystemVirtualwanlinkHealthcheckSla
, WantempSystemVirtualwanlinkHealthcheckSlaArgs

Id double
SLA ID.
JitterThreshold double
Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
LatencyThreshold double
Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
LinkCostFactors List<string>
Criteria on which to base link selection. Valid values: latency, jitter, packet-loss.
PacketlossThreshold double
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
Id float64
SLA ID.
JitterThreshold float64
Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
LatencyThreshold float64
Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
LinkCostFactors []string
Criteria on which to base link selection. Valid values: latency, jitter, packet-loss.
PacketlossThreshold float64
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
id Double
SLA ID.
jitterThreshold Double
Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
latencyThreshold Double
Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
linkCostFactors List<String>
Criteria on which to base link selection. Valid values: latency, jitter, packet-loss.
packetlossThreshold Double
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
id number
SLA ID.
jitterThreshold number
Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
latencyThreshold number
Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
linkCostFactors string[]
Criteria on which to base link selection. Valid values: latency, jitter, packet-loss.
packetlossThreshold number
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
id float
SLA ID.
jitter_threshold float
Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
latency_threshold float
Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
link_cost_factors Sequence[str]
Criteria on which to base link selection. Valid values: latency, jitter, packet-loss.
packetloss_threshold float
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
id Number
SLA ID.
jitterThreshold Number
Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
latencyThreshold Number
Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5).
linkCostFactors List<String>
Criteria on which to base link selection. Valid values: latency, jitter, packet-loss.
packetlossThreshold Number
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).

Import

Wantemp SystemVirtualWanLinkHealthCheck can be imported using any of these accepted formats:

Set import_options = [“wanprof=YOUR_VALUE”] in the provider section.

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/wantempSystemVirtualwanlinkHealthcheck:WantempSystemVirtualwanlinkHealthcheck labelname {{name}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.