Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. WantempSystemSdwanHealthcheck
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.WantempSystemSdwanHealthcheck

Explore with Pulumi AI

fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

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.WantempSystemSdwan. 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.WantempSystemSdwanHealthcheckSla

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const trnameWanTemplate = new fortimanager.WanTemplate("trnameWanTemplate", {
    adom: "root",
    type: "wanprof",
});
const trnameWantempSystemSdwanHealthcheck = new fortimanager.WantempSystemSdwanHealthcheck("trnameWantempSystemSdwanHealthcheck", {
    addrMode: "ipv4",
    wanprof: trnameWanTemplate.name,
}, {
    dependsOn: [trnameWanTemplate],
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname_wan_template = fortimanager.WanTemplate("trnameWanTemplate",
    adom="root",
    type="wanprof")
trname_wantemp_system_sdwan_healthcheck = fortimanager.WantempSystemSdwanHealthcheck("trnameWantempSystemSdwanHealthcheck",
    addr_mode="ipv4",
    wanprof=trname_wan_template.name,
    opts = pulumi.ResourceOptions(depends_on=[trname_wan_template]))
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		trnameWanTemplate, err := fortimanager.NewWanTemplate(ctx, "trnameWanTemplate", &fortimanager.WanTemplateArgs{
			Adom: pulumi.String("root"),
			Type: pulumi.String("wanprof"),
		})
		if err != nil {
			return err
		}
		_, err = fortimanager.NewWantempSystemSdwanHealthcheck(ctx, "trnameWantempSystemSdwanHealthcheck", &fortimanager.WantempSystemSdwanHealthcheckArgs{
			AddrMode: pulumi.String("ipv4"),
			Wanprof:  trnameWanTemplate.Name,
		}, pulumi.DependsOn([]pulumi.Resource{
			trnameWanTemplate,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trnameWanTemplate = new Fortimanager.WanTemplate("trnameWanTemplate", new()
    {
        Adom = "root",
        Type = "wanprof",
    });

    var trnameWantempSystemSdwanHealthcheck = new Fortimanager.WantempSystemSdwanHealthcheck("trnameWantempSystemSdwanHealthcheck", new()
    {
        AddrMode = "ipv4",
        Wanprof = trnameWanTemplate.Name,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            trnameWanTemplate,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.WanTemplate;
import com.pulumi.fortimanager.WanTemplateArgs;
import com.pulumi.fortimanager.WantempSystemSdwanHealthcheck;
import com.pulumi.fortimanager.WantempSystemSdwanHealthcheckArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trnameWanTemplate = new WanTemplate("trnameWanTemplate", WanTemplateArgs.builder()
            .adom("root")
            .type("wanprof")
            .build());

        var trnameWantempSystemSdwanHealthcheck = new WantempSystemSdwanHealthcheck("trnameWantempSystemSdwanHealthcheck", WantempSystemSdwanHealthcheckArgs.builder()
            .addrMode("ipv4")
            .wanprof(trnameWanTemplate.name())
            .build(), CustomResourceOptions.builder()
                .dependsOn(trnameWanTemplate)
                .build());

    }
}
Copy
resources:
  trnameWantempSystemSdwanHealthcheck:
    type: fortimanager:WantempSystemSdwanHealthcheck
    properties:
      addrMode: ipv4
      wanprof: ${trnameWanTemplate.name}
    options:
      dependsOn:
        - ${trnameWanTemplate}
  trnameWanTemplate:
    type: fortimanager:WanTemplate
    properties:
      adom: root
      type: wanprof
Copy

Create WantempSystemSdwanHealthcheck Resource

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

Constructor syntax

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

@overload
def WantempSystemSdwanHealthcheck(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  wanprof: Optional[str] = None,
                                  _dynamic_server: Optional[str] = None,
                                  addr_mode: Optional[str] = None,
                                  adom: Optional[str] = None,
                                  class_id: Optional[str] = None,
                                  detect_mode: Optional[str] = None,
                                  diffservcode: Optional[str] = None,
                                  dns_match_ip: Optional[str] = None,
                                  dns_request_domain: Optional[str] = None,
                                  dynamic_sort_subtable: Optional[str] = None,
                                  embed_measured_health: Optional[str] = None,
                                  failtime: Optional[float] = None,
                                  fortiguard: Optional[str] = None,
                                  fortiguard_names: Optional[Sequence[str]] = None,
                                  ftp_file: Optional[str] = None,
                                  ftp_mode: Optional[str] = None,
                                  ha_priority: Optional[float] = None,
                                  http_agent: Optional[str] = None,
                                  http_get: Optional[str] = None,
                                  http_match: Optional[str] = None,
                                  interval: Optional[float] = None,
                                  members: Optional[Sequence[str]] = None,
                                  mos_codec: Optional[str] = None,
                                  name: Optional[str] = None,
                                  packet_size: Optional[float] = None,
                                  passwords: Optional[Sequence[str]] = None,
                                  port: Optional[float] = None,
                                  probe_count: Optional[float] = None,
                                  probe_packets: Optional[str] = None,
                                  probe_timeout: Optional[float] = None,
                                  protocol: Optional[str] = None,
                                  quality_measured_method: 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_id_redistribute: Optional[float] = None,
                                  sla_pass_log_period: Optional[float] = None,
                                  slas: Optional[Sequence[WantempSystemSdwanHealthcheckSlaArgs]] = None,
                                  source: Optional[str] = None,
                                  source6: Optional[str] = None,
                                  system_dns: Optional[str] = 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,
                                  user: Optional[str] = None,
                                  vrf: Optional[float] = None,
                                  wantemp_system_sdwan_healthcheck_id: Optional[str] = None)
func NewWantempSystemSdwanHealthcheck(ctx *Context, name string, args WantempSystemSdwanHealthcheckArgs, opts ...ResourceOption) (*WantempSystemSdwanHealthcheck, error)
public WantempSystemSdwanHealthcheck(string name, WantempSystemSdwanHealthcheckArgs args, CustomResourceOptions? opts = null)
public WantempSystemSdwanHealthcheck(String name, WantempSystemSdwanHealthcheckArgs args)
public WantempSystemSdwanHealthcheck(String name, WantempSystemSdwanHealthcheckArgs args, CustomResourceOptions options)

type: fortimanager:WantempSystemSdwanHealthcheck
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. WantempSystemSdwanHealthcheckArgs
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. WantempSystemSdwanHealthcheckArgs
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. WantempSystemSdwanHealthcheckArgs
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. WantempSystemSdwanHealthcheckArgs
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. WantempSystemSdwanHealthcheckArgs
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 wantempSystemSdwanHealthcheckResource = new Fortimanager.WantempSystemSdwanHealthcheck("wantempSystemSdwanHealthcheckResource", new()
{
    Wanprof = "string",
    _dynamicServer = "string",
    AddrMode = "string",
    Adom = "string",
    ClassId = "string",
    DetectMode = "string",
    Diffservcode = "string",
    DnsMatchIp = "string",
    DnsRequestDomain = "string",
    DynamicSortSubtable = "string",
    EmbedMeasuredHealth = "string",
    Failtime = 0,
    Fortiguard = "string",
    FortiguardNames = new[]
    {
        "string",
    },
    FtpFile = "string",
    FtpMode = "string",
    HaPriority = 0,
    HttpAgent = "string",
    HttpGet = "string",
    HttpMatch = "string",
    Interval = 0,
    Members = new[]
    {
        "string",
    },
    MosCodec = "string",
    Name = "string",
    PacketSize = 0,
    Passwords = new[]
    {
        "string",
    },
    Port = 0,
    ProbeCount = 0,
    ProbePackets = "string",
    ProbeTimeout = 0,
    Protocol = "string",
    QualityMeasuredMethod = "string",
    Recoverytime = 0,
    Scopetype = "string",
    SecurityMode = "string",
    Servers = new[]
    {
        "string",
    },
    SlaFailLogPeriod = 0,
    SlaIdRedistribute = 0,
    SlaPassLogPeriod = 0,
    Slas = new[]
    {
        new Fortimanager.Inputs.WantempSystemSdwanHealthcheckSlaArgs
        {
            Id = 0,
            JitterThreshold = 0,
            LatencyThreshold = 0,
            LinkCostFactors = new[]
            {
                "string",
            },
            MosThreshold = "string",
            PacketlossThreshold = 0,
            PriorityInSla = 0,
            PriorityOutSla = 0,
        },
    },
    Source = "string",
    Source6 = "string",
    SystemDns = "string",
    ThresholdAlertJitter = 0,
    ThresholdAlertLatency = 0,
    ThresholdAlertPacketloss = 0,
    ThresholdWarningJitter = 0,
    ThresholdWarningLatency = 0,
    ThresholdWarningPacketloss = 0,
    UpdateCascadeInterface = "string",
    UpdateStaticRoute = "string",
    User = "string",
    Vrf = 0,
    WantempSystemSdwanHealthcheckId = "string",
});
Copy
example, err := fortimanager.NewWantempSystemSdwanHealthcheck(ctx, "wantempSystemSdwanHealthcheckResource", &fortimanager.WantempSystemSdwanHealthcheckArgs{
Wanprof: pulumi.String("string"),
_dynamicServer: pulumi.String("string"),
AddrMode: pulumi.String("string"),
Adom: pulumi.String("string"),
ClassId: pulumi.String("string"),
DetectMode: pulumi.String("string"),
Diffservcode: pulumi.String("string"),
DnsMatchIp: pulumi.String("string"),
DnsRequestDomain: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
EmbedMeasuredHealth: pulumi.String("string"),
Failtime: pulumi.Float64(0),
Fortiguard: pulumi.String("string"),
FortiguardNames: pulumi.StringArray{
pulumi.String("string"),
},
FtpFile: pulumi.String("string"),
FtpMode: pulumi.String("string"),
HaPriority: pulumi.Float64(0),
HttpAgent: pulumi.String("string"),
HttpGet: pulumi.String("string"),
HttpMatch: pulumi.String("string"),
Interval: pulumi.Float64(0),
Members: pulumi.StringArray{
pulumi.String("string"),
},
MosCodec: pulumi.String("string"),
Name: pulumi.String("string"),
PacketSize: pulumi.Float64(0),
Passwords: pulumi.StringArray{
pulumi.String("string"),
},
Port: pulumi.Float64(0),
ProbeCount: pulumi.Float64(0),
ProbePackets: pulumi.String("string"),
ProbeTimeout: pulumi.Float64(0),
Protocol: pulumi.String("string"),
QualityMeasuredMethod: pulumi.String("string"),
Recoverytime: pulumi.Float64(0),
Scopetype: pulumi.String("string"),
SecurityMode: pulumi.String("string"),
Servers: pulumi.StringArray{
pulumi.String("string"),
},
SlaFailLogPeriod: pulumi.Float64(0),
SlaIdRedistribute: pulumi.Float64(0),
SlaPassLogPeriod: pulumi.Float64(0),
Slas: .WantempSystemSdwanHealthcheckSlaTypeArray{
&.WantempSystemSdwanHealthcheckSlaTypeArgs{
Id: pulumi.Float64(0),
JitterThreshold: pulumi.Float64(0),
LatencyThreshold: pulumi.Float64(0),
LinkCostFactors: pulumi.StringArray{
pulumi.String("string"),
},
MosThreshold: pulumi.String("string"),
PacketlossThreshold: pulumi.Float64(0),
PriorityInSla: pulumi.Float64(0),
PriorityOutSla: pulumi.Float64(0),
},
},
Source: pulumi.String("string"),
Source6: pulumi.String("string"),
SystemDns: pulumi.String("string"),
ThresholdAlertJitter: pulumi.Float64(0),
ThresholdAlertLatency: pulumi.Float64(0),
ThresholdAlertPacketloss: pulumi.Float64(0),
ThresholdWarningJitter: pulumi.Float64(0),
ThresholdWarningLatency: pulumi.Float64(0),
ThresholdWarningPacketloss: pulumi.Float64(0),
UpdateCascadeInterface: pulumi.String("string"),
UpdateStaticRoute: pulumi.String("string"),
User: pulumi.String("string"),
Vrf: pulumi.Float64(0),
WantempSystemSdwanHealthcheckId: pulumi.String("string"),
})
Copy
var wantempSystemSdwanHealthcheckResource = new WantempSystemSdwanHealthcheck("wantempSystemSdwanHealthcheckResource", WantempSystemSdwanHealthcheckArgs.builder()
    .wanprof("string")
    ._dynamicServer("string")
    .addrMode("string")
    .adom("string")
    .classId("string")
    .detectMode("string")
    .diffservcode("string")
    .dnsMatchIp("string")
    .dnsRequestDomain("string")
    .dynamicSortSubtable("string")
    .embedMeasuredHealth("string")
    .failtime(0)
    .fortiguard("string")
    .fortiguardNames("string")
    .ftpFile("string")
    .ftpMode("string")
    .haPriority(0)
    .httpAgent("string")
    .httpGet("string")
    .httpMatch("string")
    .interval(0)
    .members("string")
    .mosCodec("string")
    .name("string")
    .packetSize(0)
    .passwords("string")
    .port(0)
    .probeCount(0)
    .probePackets("string")
    .probeTimeout(0)
    .protocol("string")
    .qualityMeasuredMethod("string")
    .recoverytime(0)
    .scopetype("string")
    .securityMode("string")
    .servers("string")
    .slaFailLogPeriod(0)
    .slaIdRedistribute(0)
    .slaPassLogPeriod(0)
    .slas(WantempSystemSdwanHealthcheckSlaArgs.builder()
        .id(0)
        .jitterThreshold(0)
        .latencyThreshold(0)
        .linkCostFactors("string")
        .mosThreshold("string")
        .packetlossThreshold(0)
        .priorityInSla(0)
        .priorityOutSla(0)
        .build())
    .source("string")
    .source6("string")
    .systemDns("string")
    .thresholdAlertJitter(0)
    .thresholdAlertLatency(0)
    .thresholdAlertPacketloss(0)
    .thresholdWarningJitter(0)
    .thresholdWarningLatency(0)
    .thresholdWarningPacketloss(0)
    .updateCascadeInterface("string")
    .updateStaticRoute("string")
    .user("string")
    .vrf(0)
    .wantempSystemSdwanHealthcheckId("string")
    .build());
Copy
wantemp_system_sdwan_healthcheck_resource = fortimanager.WantempSystemSdwanHealthcheck("wantempSystemSdwanHealthcheckResource",
    wanprof="string",
    _dynamic_server="string",
    addr_mode="string",
    adom="string",
    class_id="string",
    detect_mode="string",
    diffservcode="string",
    dns_match_ip="string",
    dns_request_domain="string",
    dynamic_sort_subtable="string",
    embed_measured_health="string",
    failtime=0,
    fortiguard="string",
    fortiguard_names=["string"],
    ftp_file="string",
    ftp_mode="string",
    ha_priority=0,
    http_agent="string",
    http_get="string",
    http_match="string",
    interval=0,
    members=["string"],
    mos_codec="string",
    name="string",
    packet_size=0,
    passwords=["string"],
    port=0,
    probe_count=0,
    probe_packets="string",
    probe_timeout=0,
    protocol="string",
    quality_measured_method="string",
    recoverytime=0,
    scopetype="string",
    security_mode="string",
    servers=["string"],
    sla_fail_log_period=0,
    sla_id_redistribute=0,
    sla_pass_log_period=0,
    slas=[{
        "id": 0,
        "jitter_threshold": 0,
        "latency_threshold": 0,
        "link_cost_factors": ["string"],
        "mos_threshold": "string",
        "packetloss_threshold": 0,
        "priority_in_sla": 0,
        "priority_out_sla": 0,
    }],
    source="string",
    source6="string",
    system_dns="string",
    threshold_alert_jitter=0,
    threshold_alert_latency=0,
    threshold_alert_packetloss=0,
    threshold_warning_jitter=0,
    threshold_warning_latency=0,
    threshold_warning_packetloss=0,
    update_cascade_interface="string",
    update_static_route="string",
    user="string",
    vrf=0,
    wantemp_system_sdwan_healthcheck_id="string")
Copy
const wantempSystemSdwanHealthcheckResource = new fortimanager.WantempSystemSdwanHealthcheck("wantempSystemSdwanHealthcheckResource", {
    wanprof: "string",
    _dynamicServer: "string",
    addrMode: "string",
    adom: "string",
    classId: "string",
    detectMode: "string",
    diffservcode: "string",
    dnsMatchIp: "string",
    dnsRequestDomain: "string",
    dynamicSortSubtable: "string",
    embedMeasuredHealth: "string",
    failtime: 0,
    fortiguard: "string",
    fortiguardNames: ["string"],
    ftpFile: "string",
    ftpMode: "string",
    haPriority: 0,
    httpAgent: "string",
    httpGet: "string",
    httpMatch: "string",
    interval: 0,
    members: ["string"],
    mosCodec: "string",
    name: "string",
    packetSize: 0,
    passwords: ["string"],
    port: 0,
    probeCount: 0,
    probePackets: "string",
    probeTimeout: 0,
    protocol: "string",
    qualityMeasuredMethod: "string",
    recoverytime: 0,
    scopetype: "string",
    securityMode: "string",
    servers: ["string"],
    slaFailLogPeriod: 0,
    slaIdRedistribute: 0,
    slaPassLogPeriod: 0,
    slas: [{
        id: 0,
        jitterThreshold: 0,
        latencyThreshold: 0,
        linkCostFactors: ["string"],
        mosThreshold: "string",
        packetlossThreshold: 0,
        priorityInSla: 0,
        priorityOutSla: 0,
    }],
    source: "string",
    source6: "string",
    systemDns: "string",
    thresholdAlertJitter: 0,
    thresholdAlertLatency: 0,
    thresholdAlertPacketloss: 0,
    thresholdWarningJitter: 0,
    thresholdWarningLatency: 0,
    thresholdWarningPacketloss: 0,
    updateCascadeInterface: "string",
    updateStaticRoute: "string",
    user: "string",
    vrf: 0,
    wantempSystemSdwanHealthcheckId: "string",
});
Copy
type: fortimanager:WantempSystemSdwanHealthcheck
properties:
    _dynamicServer: string
    addrMode: string
    adom: string
    classId: string
    detectMode: string
    diffservcode: string
    dnsMatchIp: string
    dnsRequestDomain: string
    dynamicSortSubtable: string
    embedMeasuredHealth: string
    failtime: 0
    fortiguard: string
    fortiguardNames:
        - string
    ftpFile: string
    ftpMode: string
    haPriority: 0
    httpAgent: string
    httpGet: string
    httpMatch: string
    interval: 0
    members:
        - string
    mosCodec: string
    name: string
    packetSize: 0
    passwords:
        - string
    port: 0
    probeCount: 0
    probePackets: string
    probeTimeout: 0
    protocol: string
    qualityMeasuredMethod: string
    recoverytime: 0
    scopetype: string
    securityMode: string
    servers:
        - string
    slaFailLogPeriod: 0
    slaIdRedistribute: 0
    slaPassLogPeriod: 0
    slas:
        - id: 0
          jitterThreshold: 0
          latencyThreshold: 0
          linkCostFactors:
            - string
          mosThreshold: string
          packetlossThreshold: 0
          priorityInSla: 0
          priorityOutSla: 0
    source: string
    source6: string
    systemDns: string
    thresholdAlertJitter: 0
    thresholdAlertLatency: 0
    thresholdAlertPacketloss: 0
    thresholdWarningJitter: 0
    thresholdWarningLatency: 0
    thresholdWarningPacketloss: 0
    updateCascadeInterface: string
    updateStaticRoute: string
    user: string
    vrf: 0
    wanprof: string
    wantempSystemSdwanHealthcheckId: string
Copy

WantempSystemSdwanHealthcheck 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 WantempSystemSdwanHealthcheck 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.
ClassId string
Traffic class ID.
DetectMode string
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
Diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
DnsMatchIp string
Response IP expected from DNS server if the protocol is DNS.
DnsRequestDomain string
Fully qualified domain name to resolve for the DNS probe.
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.
EmbedMeasuredHealth string
Enable/disable embedding measured health information. Valid values: disable, enable.
Failtime double
Number of failures before server is considered lost (1 - 3600, default = 5).
Fortiguard string
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
FortiguardNames List<string>
Predefined health-check target name.
FtpFile string
Full path and file name on the FTP server to download for FTP health-check to probe.
FtpMode string
FTP mode. Valid values: passive, port.
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.
Interval double
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
Members List<string>
Member sequence number list.
MosCodec string
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
ProbeCount double
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
QualityMeasuredMethod string
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
SlaIdRedistribute double
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, default = 0).
SlaPassLogPeriod double
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
Slas List<WantempSystemSdwanHealthcheckSla>
Sla. The structure of sla block is documented below.
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.
SystemDns string
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
User string
The user name to access probe server.
Vrf double
Virtual Routing Forwarding ID.
WantempSystemSdwanHealthcheckId 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.
ClassId string
Traffic class ID.
DetectMode string
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
Diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
DnsMatchIp string
Response IP expected from DNS server if the protocol is DNS.
DnsRequestDomain string
Fully qualified domain name to resolve for the DNS probe.
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.
EmbedMeasuredHealth string
Enable/disable embedding measured health information. Valid values: disable, enable.
Failtime float64
Number of failures before server is considered lost (1 - 3600, default = 5).
Fortiguard string
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
FortiguardNames []string
Predefined health-check target name.
FtpFile string
Full path and file name on the FTP server to download for FTP health-check to probe.
FtpMode string
FTP mode. Valid values: passive, port.
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.
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.
MosCodec string
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
ProbeCount float64
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
QualityMeasuredMethod string
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
SlaIdRedistribute float64
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, default = 0).
SlaPassLogPeriod float64
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
Slas []WantempSystemSdwanHealthcheckSlaTypeArgs
Sla. The structure of sla block is documented below.
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.
SystemDns string
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
User string
The user name to access probe server.
Vrf float64
Virtual Routing Forwarding ID.
WantempSystemSdwanHealthcheckId 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.
classId String
Traffic class ID.
detectMode String
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
diffservcode String
Differentiated services code point (DSCP) in the IP header of the probe packet.
dnsMatchIp String
Response IP expected from DNS server if the protocol is DNS.
dnsRequestDomain String
Fully qualified domain name to resolve for the DNS probe.
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.
embedMeasuredHealth String
Enable/disable embedding measured health information. Valid values: disable, enable.
failtime Double
Number of failures before server is considered lost (1 - 3600, default = 5).
fortiguard String
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
fortiguardNames List<String>
Predefined health-check target name.
ftpFile String
Full path and file name on the FTP server to download for FTP health-check to probe.
ftpMode String
FTP mode. Valid values: passive, port.
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.
interval Double
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members List<String>
Member sequence number list.
mosCodec String
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
probeCount Double
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
qualityMeasuredMethod String
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
slaIdRedistribute Double
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, default = 0).
slaPassLogPeriod Double
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas List<WantempSystemSdwanHealthcheckSla>
Sla. The structure of sla block is documented below.
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.
systemDns String
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
user String
The user name to access probe server.
vrf Double
Virtual Routing Forwarding ID.
wantempSystemSdwanHealthcheckId 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.
classId string
Traffic class ID.
detectMode string
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
dnsMatchIp string
Response IP expected from DNS server if the protocol is DNS.
dnsRequestDomain string
Fully qualified domain name to resolve for the DNS probe.
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.
embedMeasuredHealth string
Enable/disable embedding measured health information. Valid values: disable, enable.
failtime number
Number of failures before server is considered lost (1 - 3600, default = 5).
fortiguard string
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
fortiguardNames string[]
Predefined health-check target name.
ftpFile string
Full path and file name on the FTP server to download for FTP health-check to probe.
ftpMode string
FTP mode. Valid values: passive, port.
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.
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.
mosCodec string
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
probeCount number
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
qualityMeasuredMethod string
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
slaIdRedistribute number
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, default = 0).
slaPassLogPeriod number
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas WantempSystemSdwanHealthcheckSla[]
Sla. The structure of sla block is documented below.
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.
systemDns string
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
user string
The user name to access probe server.
vrf number
Virtual Routing Forwarding ID.
wantempSystemSdwanHealthcheckId 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.
class_id str
Traffic class ID.
detect_mode str
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
diffservcode str
Differentiated services code point (DSCP) in the IP header of the probe packet.
dns_match_ip str
Response IP expected from DNS server if the protocol is DNS.
dns_request_domain str
Fully qualified domain name to resolve for the DNS probe.
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.
embed_measured_health str
Enable/disable embedding measured health information. Valid values: disable, enable.
failtime float
Number of failures before server is considered lost (1 - 3600, default = 5).
fortiguard str
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
fortiguard_names Sequence[str]
Predefined health-check target name.
ftp_file str
Full path and file name on the FTP server to download for FTP health-check to probe.
ftp_mode str
FTP mode. Valid values: passive, port.
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.
interval float
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members Sequence[str]
Member sequence number list.
mos_codec str
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
probe_count float
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
quality_measured_method str
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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_id_redistribute float
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, 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[WantempSystemSdwanHealthcheckSlaArgs]
Sla. The structure of sla block is documented below.
source str
Source IP address used in the health-check packet to the server.
source6 str
Source IPv6 addressused in the health-check packet to server.
system_dns str
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
user str
The user name to access probe server.
vrf float
Virtual Routing Forwarding ID.
wantemp_system_sdwan_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.
classId String
Traffic class ID.
detectMode String
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
diffservcode String
Differentiated services code point (DSCP) in the IP header of the probe packet.
dnsMatchIp String
Response IP expected from DNS server if the protocol is DNS.
dnsRequestDomain String
Fully qualified domain name to resolve for the DNS probe.
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.
embedMeasuredHealth String
Enable/disable embedding measured health information. Valid values: disable, enable.
failtime Number
Number of failures before server is considered lost (1 - 3600, default = 5).
fortiguard String
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
fortiguardNames List<String>
Predefined health-check target name.
ftpFile String
Full path and file name on the FTP server to download for FTP health-check to probe.
ftpMode String
FTP mode. Valid values: passive, port.
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.
interval Number
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members List<String>
Member sequence number list.
mosCodec String
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
probeCount Number
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
qualityMeasuredMethod String
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
slaIdRedistribute Number
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, 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.
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.
systemDns String
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
user String
The user name to access probe server.
vrf Number
Virtual Routing Forwarding ID.
wantempSystemSdwanHealthcheckId String
an identifier for the resource with format {{name}}.

Outputs

All input properties are implicitly available as output properties. Additionally, the WantempSystemSdwanHealthcheck 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 WantempSystemSdwanHealthcheck Resource

Get an existing WantempSystemSdwanHealthcheck 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?: WantempSystemSdwanHealthcheckState, opts?: CustomResourceOptions): WantempSystemSdwanHealthcheck
@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,
        class_id: Optional[str] = None,
        detect_mode: Optional[str] = None,
        diffservcode: Optional[str] = None,
        dns_match_ip: Optional[str] = None,
        dns_request_domain: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        embed_measured_health: Optional[str] = None,
        failtime: Optional[float] = None,
        fortiguard: Optional[str] = None,
        fortiguard_names: Optional[Sequence[str]] = None,
        ftp_file: Optional[str] = None,
        ftp_mode: Optional[str] = None,
        ha_priority: Optional[float] = None,
        http_agent: Optional[str] = None,
        http_get: Optional[str] = None,
        http_match: Optional[str] = None,
        interval: Optional[float] = None,
        members: Optional[Sequence[str]] = None,
        mos_codec: Optional[str] = None,
        name: Optional[str] = None,
        packet_size: Optional[float] = None,
        passwords: Optional[Sequence[str]] = None,
        port: Optional[float] = None,
        probe_count: Optional[float] = None,
        probe_packets: Optional[str] = None,
        probe_timeout: Optional[float] = None,
        protocol: Optional[str] = None,
        quality_measured_method: 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_id_redistribute: Optional[float] = None,
        sla_pass_log_period: Optional[float] = None,
        slas: Optional[Sequence[WantempSystemSdwanHealthcheckSlaArgs]] = None,
        source: Optional[str] = None,
        source6: Optional[str] = None,
        system_dns: Optional[str] = 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,
        user: Optional[str] = None,
        vrf: Optional[float] = None,
        wanprof: Optional[str] = None,
        wantemp_system_sdwan_healthcheck_id: Optional[str] = None) -> WantempSystemSdwanHealthcheck
func GetWantempSystemSdwanHealthcheck(ctx *Context, name string, id IDInput, state *WantempSystemSdwanHealthcheckState, opts ...ResourceOption) (*WantempSystemSdwanHealthcheck, error)
public static WantempSystemSdwanHealthcheck Get(string name, Input<string> id, WantempSystemSdwanHealthcheckState? state, CustomResourceOptions? opts = null)
public static WantempSystemSdwanHealthcheck get(String name, Output<String> id, WantempSystemSdwanHealthcheckState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:WantempSystemSdwanHealthcheck    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.
ClassId string
Traffic class ID.
DetectMode string
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
Diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
DnsMatchIp string
Response IP expected from DNS server if the protocol is DNS.
DnsRequestDomain string
Fully qualified domain name to resolve for the DNS probe.
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.
EmbedMeasuredHealth string
Enable/disable embedding measured health information. Valid values: disable, enable.
Failtime double
Number of failures before server is considered lost (1 - 3600, default = 5).
Fortiguard string
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
FortiguardNames List<string>
Predefined health-check target name.
FtpFile string
Full path and file name on the FTP server to download for FTP health-check to probe.
FtpMode string
FTP mode. Valid values: passive, port.
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.
Interval double
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
Members List<string>
Member sequence number list.
MosCodec string
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
ProbeCount double
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
QualityMeasuredMethod string
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
SlaIdRedistribute double
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, default = 0).
SlaPassLogPeriod double
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
Slas List<WantempSystemSdwanHealthcheckSla>
Sla. The structure of sla block is documented below.
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.
SystemDns string
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
User string
The user name to access probe server.
Vrf double
Virtual Routing Forwarding ID.
Wanprof string
Wanprof.
WantempSystemSdwanHealthcheckId 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.
ClassId string
Traffic class ID.
DetectMode string
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
Diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
DnsMatchIp string
Response IP expected from DNS server if the protocol is DNS.
DnsRequestDomain string
Fully qualified domain name to resolve for the DNS probe.
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.
EmbedMeasuredHealth string
Enable/disable embedding measured health information. Valid values: disable, enable.
Failtime float64
Number of failures before server is considered lost (1 - 3600, default = 5).
Fortiguard string
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
FortiguardNames []string
Predefined health-check target name.
FtpFile string
Full path and file name on the FTP server to download for FTP health-check to probe.
FtpMode string
FTP mode. Valid values: passive, port.
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.
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.
MosCodec string
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
ProbeCount float64
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
QualityMeasuredMethod string
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
SlaIdRedistribute float64
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, default = 0).
SlaPassLogPeriod float64
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
Slas []WantempSystemSdwanHealthcheckSlaTypeArgs
Sla. The structure of sla block is documented below.
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.
SystemDns string
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
User string
The user name to access probe server.
Vrf float64
Virtual Routing Forwarding ID.
Wanprof string
Wanprof.
WantempSystemSdwanHealthcheckId 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.
classId String
Traffic class ID.
detectMode String
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
diffservcode String
Differentiated services code point (DSCP) in the IP header of the probe packet.
dnsMatchIp String
Response IP expected from DNS server if the protocol is DNS.
dnsRequestDomain String
Fully qualified domain name to resolve for the DNS probe.
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.
embedMeasuredHealth String
Enable/disable embedding measured health information. Valid values: disable, enable.
failtime Double
Number of failures before server is considered lost (1 - 3600, default = 5).
fortiguard String
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
fortiguardNames List<String>
Predefined health-check target name.
ftpFile String
Full path and file name on the FTP server to download for FTP health-check to probe.
ftpMode String
FTP mode. Valid values: passive, port.
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.
interval Double
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members List<String>
Member sequence number list.
mosCodec String
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
probeCount Double
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
qualityMeasuredMethod String
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
slaIdRedistribute Double
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, default = 0).
slaPassLogPeriod Double
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas List<WantempSystemSdwanHealthcheckSla>
Sla. The structure of sla block is documented below.
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.
systemDns String
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
user String
The user name to access probe server.
vrf Double
Virtual Routing Forwarding ID.
wanprof String
Wanprof.
wantempSystemSdwanHealthcheckId 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.
classId string
Traffic class ID.
detectMode string
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
diffservcode string
Differentiated services code point (DSCP) in the IP header of the probe packet.
dnsMatchIp string
Response IP expected from DNS server if the protocol is DNS.
dnsRequestDomain string
Fully qualified domain name to resolve for the DNS probe.
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.
embedMeasuredHealth string
Enable/disable embedding measured health information. Valid values: disable, enable.
failtime number
Number of failures before server is considered lost (1 - 3600, default = 5).
fortiguard string
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
fortiguardNames string[]
Predefined health-check target name.
ftpFile string
Full path and file name on the FTP server to download for FTP health-check to probe.
ftpMode string
FTP mode. Valid values: passive, port.
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.
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.
mosCodec string
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
probeCount number
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
qualityMeasuredMethod string
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
slaIdRedistribute number
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, default = 0).
slaPassLogPeriod number
Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).
slas WantempSystemSdwanHealthcheckSla[]
Sla. The structure of sla block is documented below.
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.
systemDns string
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
user string
The user name to access probe server.
vrf number
Virtual Routing Forwarding ID.
wanprof string
Wanprof.
wantempSystemSdwanHealthcheckId 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.
class_id str
Traffic class ID.
detect_mode str
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
diffservcode str
Differentiated services code point (DSCP) in the IP header of the probe packet.
dns_match_ip str
Response IP expected from DNS server if the protocol is DNS.
dns_request_domain str
Fully qualified domain name to resolve for the DNS probe.
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.
embed_measured_health str
Enable/disable embedding measured health information. Valid values: disable, enable.
failtime float
Number of failures before server is considered lost (1 - 3600, default = 5).
fortiguard str
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
fortiguard_names Sequence[str]
Predefined health-check target name.
ftp_file str
Full path and file name on the FTP server to download for FTP health-check to probe.
ftp_mode str
FTP mode. Valid values: passive, port.
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.
interval float
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members Sequence[str]
Member sequence number list.
mos_codec str
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
probe_count float
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
quality_measured_method str
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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_id_redistribute float
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, 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[WantempSystemSdwanHealthcheckSlaArgs]
Sla. The structure of sla block is documented below.
source str
Source IP address used in the health-check packet to the server.
source6 str
Source IPv6 addressused in the health-check packet to server.
system_dns str
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
user str
The user name to access probe server.
vrf float
Virtual Routing Forwarding ID.
wanprof str
Wanprof.
wantemp_system_sdwan_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.
classId String
Traffic class ID.
detectMode String
The mode determining how to detect the server. Valid values: active, passive, prefer-passive.
diffservcode String
Differentiated services code point (DSCP) in the IP header of the probe packet.
dnsMatchIp String
Response IP expected from DNS server if the protocol is DNS.
dnsRequestDomain String
Fully qualified domain name to resolve for the DNS probe.
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.
embedMeasuredHealth String
Enable/disable embedding measured health information. Valid values: disable, enable.
failtime Number
Number of failures before server is considered lost (1 - 3600, default = 5).
fortiguard String
Enable/disable use of FortiGuard predefined server. Valid values: disable, enable.
fortiguardNames List<String>
Predefined health-check target name.
ftpFile String
Full path and file name on the FTP server to download for FTP health-check to probe.
ftpMode String
FTP mode. Valid values: passive, port.
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.
interval Number
Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500).
members List<String>
Member sequence number list.
mosCodec String
Codec to use for MOS calculation (default = g711). Valid values: g711, g722, g729.
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 (0-65535, default = 0, auto select. http, twamp: 80, udp-echo, tcp-echo: 7, dns: 53, ftp: 21).
probeCount Number
Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
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 - 3600*1000 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, tcp-connect, ftp.
qualityMeasuredMethod String
Method to measure the quality of tcp-connect. Valid values: half-close, half-open.
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).
slaIdRedistribute Number
Select the ID from the SLA sub-table. The selected SLA's priority value will be distributed into the routing table (0 - 32, 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.
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.
systemDns String
Enable/disable system DNS as the probe server. Valid values: disable, enable.
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.
user String
The user name to access probe server.
vrf Number
Virtual Routing Forwarding ID.
wanprof String
Wanprof.
wantempSystemSdwanHealthcheckId String
an identifier for the resource with format {{name}}.

Supporting Types

WantempSystemSdwanHealthcheckSla
, WantempSystemSdwanHealthcheckSlaArgs

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.
MosThreshold string
Minimum Mean Opinion Score for SLA to be marked as pass. (1.0 - 5.0, default = 3.6).
PacketlossThreshold double
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
PriorityInSla double
Value to be distributed into routing table when in-sla (0 - 65535, default = 0).
PriorityOutSla double
Value to be distributed into routing table when out-sla (0 - 65535, 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.
MosThreshold string
Minimum Mean Opinion Score for SLA to be marked as pass. (1.0 - 5.0, default = 3.6).
PacketlossThreshold float64
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
PriorityInSla float64
Value to be distributed into routing table when in-sla (0 - 65535, default = 0).
PriorityOutSla float64
Value to be distributed into routing table when out-sla (0 - 65535, 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.
mosThreshold String
Minimum Mean Opinion Score for SLA to be marked as pass. (1.0 - 5.0, default = 3.6).
packetlossThreshold Double
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
priorityInSla Double
Value to be distributed into routing table when in-sla (0 - 65535, default = 0).
priorityOutSla Double
Value to be distributed into routing table when out-sla (0 - 65535, 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.
mosThreshold string
Minimum Mean Opinion Score for SLA to be marked as pass. (1.0 - 5.0, default = 3.6).
packetlossThreshold number
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
priorityInSla number
Value to be distributed into routing table when in-sla (0 - 65535, default = 0).
priorityOutSla number
Value to be distributed into routing table when out-sla (0 - 65535, 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.
mos_threshold str
Minimum Mean Opinion Score for SLA to be marked as pass. (1.0 - 5.0, default = 3.6).
packetloss_threshold float
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
priority_in_sla float
Value to be distributed into routing table when in-sla (0 - 65535, default = 0).
priority_out_sla float
Value to be distributed into routing table when out-sla (0 - 65535, 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.
mosThreshold String
Minimum Mean Opinion Score for SLA to be marked as pass. (1.0 - 5.0, default = 3.6).
packetlossThreshold Number
Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).
priorityInSla Number
Value to be distributed into routing table when in-sla (0 - 65535, default = 0).
priorityOutSla Number
Value to be distributed into routing table when out-sla (0 - 65535, default = 0).

Import

Wantemp SystemSdwanHealthCheck 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/wantempSystemSdwanHealthcheck:WantempSystemSdwanHealthcheck 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.
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager