Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Linkmonitor
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Linkmonitor

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Configure Link Health Monitor.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.system.Linkmonitor("trname", {
    addrMode: "ipv4",
    failtime: 5,
    gatewayIp: "2.2.2.2",
    gatewayIp6: "::",
    haPriority: 1,
    httpAgent: "Chrome/ Safari/",
    httpGet: "/",
    interval: 1,
    packetSize: 64,
    port: 80,
    protocol: "ping",
    recoverytime: 5,
    securityMode: "none",
    servers: [{
        address: "3.3.3.3",
    }],
    sourceIp: "0.0.0.0",
    sourceIp6: "::",
    srcintf: "port4",
    status: "enable",
    updateCascadeInterface: "enable",
    updateStaticRoute: "enable",
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Linkmonitor("trname",
    addr_mode="ipv4",
    failtime=5,
    gateway_ip="2.2.2.2",
    gateway_ip6="::",
    ha_priority=1,
    http_agent="Chrome/ Safari/",
    http_get="/",
    interval=1,
    packet_size=64,
    port=80,
    protocol="ping",
    recoverytime=5,
    security_mode="none",
    servers=[fortios.system.LinkmonitorServerArgs(
        address="3.3.3.3",
    )],
    source_ip="0.0.0.0",
    source_ip6="::",
    srcintf="port4",
    status="enable",
    update_cascade_interface="enable",
    update_static_route="enable")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := system.NewLinkmonitor(ctx, "trname", &system.LinkmonitorArgs{
			AddrMode:     pulumi.String("ipv4"),
			Failtime:     pulumi.Int(5),
			GatewayIp:    pulumi.String("2.2.2.2"),
			GatewayIp6:   pulumi.String("::"),
			HaPriority:   pulumi.Int(1),
			HttpAgent:    pulumi.String("Chrome/ Safari/"),
			HttpGet:      pulumi.String("/"),
			Interval:     pulumi.Int(1),
			PacketSize:   pulumi.Int(64),
			Port:         pulumi.Int(80),
			Protocol:     pulumi.String("ping"),
			Recoverytime: pulumi.Int(5),
			SecurityMode: pulumi.String("none"),
			Servers: system.LinkmonitorServerArray{
				&system.LinkmonitorServerArgs{
					Address: pulumi.String("3.3.3.3"),
				},
			},
			SourceIp:               pulumi.String("0.0.0.0"),
			SourceIp6:              pulumi.String("::"),
			Srcintf:                pulumi.String("port4"),
			Status:                 pulumi.String("enable"),
			UpdateCascadeInterface: pulumi.String("enable"),
			UpdateStaticRoute:      pulumi.String("enable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Linkmonitor("trname", new()
    {
        AddrMode = "ipv4",
        Failtime = 5,
        GatewayIp = "2.2.2.2",
        GatewayIp6 = "::",
        HaPriority = 1,
        HttpAgent = "Chrome/ Safari/",
        HttpGet = "/",
        Interval = 1,
        PacketSize = 64,
        Port = 80,
        Protocol = "ping",
        Recoverytime = 5,
        SecurityMode = "none",
        Servers = new[]
        {
            new Fortios.System.Inputs.LinkmonitorServerArgs
            {
                Address = "3.3.3.3",
            },
        },
        SourceIp = "0.0.0.0",
        SourceIp6 = "::",
        Srcintf = "port4",
        Status = "enable",
        UpdateCascadeInterface = "enable",
        UpdateStaticRoute = "enable",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Linkmonitor;
import com.pulumi.fortios.system.LinkmonitorArgs;
import com.pulumi.fortios.system.inputs.LinkmonitorServerArgs;
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 trname = new Linkmonitor("trname", LinkmonitorArgs.builder()        
            .addrMode("ipv4")
            .failtime(5)
            .gatewayIp("2.2.2.2")
            .gatewayIp6("::")
            .haPriority(1)
            .httpAgent("Chrome/ Safari/")
            .httpGet("/")
            .interval(1)
            .packetSize(64)
            .port(80)
            .protocol("ping")
            .recoverytime(5)
            .securityMode("none")
            .servers(LinkmonitorServerArgs.builder()
                .address("3.3.3.3")
                .build())
            .sourceIp("0.0.0.0")
            .sourceIp6("::")
            .srcintf("port4")
            .status("enable")
            .updateCascadeInterface("enable")
            .updateStaticRoute("enable")
            .build());

    }
}

    resources:
  trname:
    type: fortios:system:Linkmonitor
    properties:
      addrMode: ipv4
      failtime: 5
      gatewayIp: 2.2.2.2
      gatewayIp6: '::'
      haPriority: 1
      httpAgent: Chrome/ Safari/
      httpGet: /
      interval: 1
      packetSize: 64
      port: 80
      protocol: ping
      recoverytime: 5
      securityMode: none
      servers:
        - address: 3.3.3.3
      sourceIp: 0.0.0.0
      sourceIp6: '::'
      srcintf: port4
      status: enable
      updateCascadeInterface: enable
      updateStaticRoute: enable

    Create Linkmonitor Resource

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

    Constructor syntax

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

@overload
def Linkmonitor(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                servers: Optional[Sequence[LinkmonitorServerArgs]] = None,
                ha_priority: Optional[int] = None,
                fail_weight: Optional[int] = None,
                port: Optional[int] = None,
                probe_count: Optional[int] = None,
                failtime: Optional[int] = None,
                gateway_ip: Optional[str] = None,
                gateway_ip6: Optional[str] = None,
                get_all_tables: Optional[str] = None,
                addr_mode: Optional[str] = None,
                http_agent: Optional[str] = None,
                http_get: Optional[str] = None,
                http_match: Optional[str] = None,
                interval: Optional[int] = None,
                name: Optional[str] = None,
                packet_size: Optional[int] = None,
                password: Optional[str] = None,
                dynamic_sort_subtable: Optional[str] = None,
                probe_timeout: Optional[int] = None,
                diffservcode: Optional[str] = None,
                protocol: Optional[str] = None,
                recoverytime: Optional[int] = None,
                routes: Optional[Sequence[LinkmonitorRouteArgs]] = None,
                security_mode: Optional[str] = None,
                server_config: Optional[str] = None,
                server_lists: Optional[Sequence[LinkmonitorServerListArgs]] = None,
                server_type: Optional[str] = None,
                class_id: Optional[int] = None,
                service_detection: Optional[str] = None,
                source_ip: Optional[str] = None,
                source_ip6: Optional[str] = None,
                srcintf: Optional[str] = None,
                status: Optional[str] = None,
                update_cascade_interface: Optional[str] = None,
                update_policy_route: Optional[str] = None,
                update_static_route: Optional[str] = None,
                vdomparam: Optional[str] = None)
    func NewLinkmonitor(ctx *Context, name string, args LinkmonitorArgs, opts ...ResourceOption) (*Linkmonitor, error)
    public Linkmonitor(string name, LinkmonitorArgs args, CustomResourceOptions? opts = null)
    public Linkmonitor(String name, LinkmonitorArgs args)
public Linkmonitor(String name, LinkmonitorArgs args, CustomResourceOptions options)

    type: fortios:system:Linkmonitor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LinkmonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LinkmonitorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LinkmonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkmonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkmonitorArgs
    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 linkmonitorResource = new Fortios.System.Linkmonitor("linkmonitorResource", new()
{
    Servers = new[]
    {
        new Fortios.System.Inputs.LinkmonitorServerArgs
        {
            Address = "string",
        },
    },
    HaPriority = 0,
    FailWeight = 0,
    Port = 0,
    ProbeCount = 0,
    Failtime = 0,
    GatewayIp = "string",
    GatewayIp6 = "string",
    GetAllTables = "string",
    AddrMode = "string",
    HttpAgent = "string",
    HttpGet = "string",
    HttpMatch = "string",
    Interval = 0,
    Name = "string",
    PacketSize = 0,
    Password = "string",
    DynamicSortSubtable = "string",
    ProbeTimeout = 0,
    Diffservcode = "string",
    Protocol = "string",
    Recoverytime = 0,
    Routes = new[]
    {
        new Fortios.System.Inputs.LinkmonitorRouteArgs
        {
            Subnet = "string",
        },
    },
    SecurityMode = "string",
    ServerConfig = "string",
    ServerLists = new[]
    {
        new Fortios.System.Inputs.LinkmonitorServerListArgs
        {
            Dst = "string",
            Id = 0,
            Port = 0,
            Protocol = "string",
            Weight = 0,
        },
    },
    ServerType = "string",
    ClassId = 0,
    ServiceDetection = "string",
    SourceIp = "string",
    SourceIp6 = "string",
    Srcintf = "string",
    Status = "string",
    UpdateCascadeInterface = "string",
    UpdatePolicyRoute = "string",
    UpdateStaticRoute = "string",
    Vdomparam = "string",
});

    example, err := system.NewLinkmonitor(ctx, "linkmonitorResource", &system.LinkmonitorArgs{
	Servers: system.LinkmonitorServerArray{
		&system.LinkmonitorServerArgs{
			Address: pulumi.String("string"),
		},
	},
	HaPriority:          pulumi.Int(0),
	FailWeight:          pulumi.Int(0),
	Port:                pulumi.Int(0),
	ProbeCount:          pulumi.Int(0),
	Failtime:            pulumi.Int(0),
	GatewayIp:           pulumi.String("string"),
	GatewayIp6:          pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	AddrMode:            pulumi.String("string"),
	HttpAgent:           pulumi.String("string"),
	HttpGet:             pulumi.String("string"),
	HttpMatch:           pulumi.String("string"),
	Interval:            pulumi.Int(0),
	Name:                pulumi.String("string"),
	PacketSize:          pulumi.Int(0),
	Password:            pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	ProbeTimeout:        pulumi.Int(0),
	Diffservcode:        pulumi.String("string"),
	Protocol:            pulumi.String("string"),
	Recoverytime:        pulumi.Int(0),
	Routes: system.LinkmonitorRouteArray{
		&system.LinkmonitorRouteArgs{
			Subnet: pulumi.String("string"),
		},
	},
	SecurityMode: pulumi.String("string"),
	ServerConfig: pulumi.String("string"),
	ServerLists: system.LinkmonitorServerListArray{
		&system.LinkmonitorServerListArgs{
			Dst:      pulumi.String("string"),
			Id:       pulumi.Int(0),
			Port:     pulumi.Int(0),
			Protocol: pulumi.String("string"),
			Weight:   pulumi.Int(0),
		},
	},
	ServerType:             pulumi.String("string"),
	ClassId:                pulumi.Int(0),
	ServiceDetection:       pulumi.String("string"),
	SourceIp:               pulumi.String("string"),
	SourceIp6:              pulumi.String("string"),
	Srcintf:                pulumi.String("string"),
	Status:                 pulumi.String("string"),
	UpdateCascadeInterface: pulumi.String("string"),
	UpdatePolicyRoute:      pulumi.String("string"),
	UpdateStaticRoute:      pulumi.String("string"),
	Vdomparam:              pulumi.String("string"),
})

    var linkmonitorResource = new Linkmonitor("linkmonitorResource", LinkmonitorArgs.builder()
    .servers(LinkmonitorServerArgs.builder()
        .address("string")
        .build())
    .haPriority(0)
    .failWeight(0)
    .port(0)
    .probeCount(0)
    .failtime(0)
    .gatewayIp("string")
    .gatewayIp6("string")
    .getAllTables("string")
    .addrMode("string")
    .httpAgent("string")
    .httpGet("string")
    .httpMatch("string")
    .interval(0)
    .name("string")
    .packetSize(0)
    .password("string")
    .dynamicSortSubtable("string")
    .probeTimeout(0)
    .diffservcode("string")
    .protocol("string")
    .recoverytime(0)
    .routes(LinkmonitorRouteArgs.builder()
        .subnet("string")
        .build())
    .securityMode("string")
    .serverConfig("string")
    .serverLists(LinkmonitorServerListArgs.builder()
        .dst("string")
        .id(0)
        .port(0)
        .protocol("string")
        .weight(0)
        .build())
    .serverType("string")
    .classId(0)
    .serviceDetection("string")
    .sourceIp("string")
    .sourceIp6("string")
    .srcintf("string")
    .status("string")
    .updateCascadeInterface("string")
    .updatePolicyRoute("string")
    .updateStaticRoute("string")
    .vdomparam("string")
    .build());

    linkmonitor_resource = fortios.system.Linkmonitor("linkmonitorResource",
    servers=[fortios.system.LinkmonitorServerArgs(
        address="string",
    )],
    ha_priority=0,
    fail_weight=0,
    port=0,
    probe_count=0,
    failtime=0,
    gateway_ip="string",
    gateway_ip6="string",
    get_all_tables="string",
    addr_mode="string",
    http_agent="string",
    http_get="string",
    http_match="string",
    interval=0,
    name="string",
    packet_size=0,
    password="string",
    dynamic_sort_subtable="string",
    probe_timeout=0,
    diffservcode="string",
    protocol="string",
    recoverytime=0,
    routes=[fortios.system.LinkmonitorRouteArgs(
        subnet="string",
    )],
    security_mode="string",
    server_config="string",
    server_lists=[fortios.system.LinkmonitorServerListArgs(
        dst="string",
        id=0,
        port=0,
        protocol="string",
        weight=0,
    )],
    server_type="string",
    class_id=0,
    service_detection="string",
    source_ip="string",
    source_ip6="string",
    srcintf="string",
    status="string",
    update_cascade_interface="string",
    update_policy_route="string",
    update_static_route="string",
    vdomparam="string")

    const linkmonitorResource = new fortios.system.Linkmonitor("linkmonitorResource", {
    servers: [{
        address: "string",
    }],
    haPriority: 0,
    failWeight: 0,
    port: 0,
    probeCount: 0,
    failtime: 0,
    gatewayIp: "string",
    gatewayIp6: "string",
    getAllTables: "string",
    addrMode: "string",
    httpAgent: "string",
    httpGet: "string",
    httpMatch: "string",
    interval: 0,
    name: "string",
    packetSize: 0,
    password: "string",
    dynamicSortSubtable: "string",
    probeTimeout: 0,
    diffservcode: "string",
    protocol: "string",
    recoverytime: 0,
    routes: [{
        subnet: "string",
    }],
    securityMode: "string",
    serverConfig: "string",
    serverLists: [{
        dst: "string",
        id: 0,
        port: 0,
        protocol: "string",
        weight: 0,
    }],
    serverType: "string",
    classId: 0,
    serviceDetection: "string",
    sourceIp: "string",
    sourceIp6: "string",
    srcintf: "string",
    status: "string",
    updateCascadeInterface: "string",
    updatePolicyRoute: "string",
    updateStaticRoute: "string",
    vdomparam: "string",
});

    type: fortios:system:Linkmonitor
properties:
    addrMode: string
    classId: 0
    diffservcode: string
    dynamicSortSubtable: string
    failWeight: 0
    failtime: 0
    gatewayIp: string
    gatewayIp6: string
    getAllTables: string
    haPriority: 0
    httpAgent: string
    httpGet: string
    httpMatch: string
    interval: 0
    name: string
    packetSize: 0
    password: string
    port: 0
    probeCount: 0
    probeTimeout: 0
    protocol: string
    recoverytime: 0
    routes:
        - subnet: string
    securityMode: string
    serverConfig: string
    serverLists:
        - dst: string
          id: 0
          port: 0
          protocol: string
          weight: 0
    serverType: string
    servers:
        - address: string
    serviceDetection: string
    sourceIp: string
    sourceIp6: string
    srcintf: string
    status: string
    updateCascadeInterface: string
    updatePolicyRoute: string
    updateStaticRoute: string
    vdomparam: string

    Linkmonitor Resource Properties

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

    Inputs

    The Linkmonitor resource accepts the following input properties:

    Servers List<Pulumiverse.Fortios.System.Inputs.LinkmonitorServer>
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    AddrMode string
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    ClassId int
    Traffic class ID.
    Diffservcode string
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    FailWeight int
    Threshold weight to trigger link failure alert.
    Failtime int
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    GatewayIp string
    Gateway IP address used to probe the server.
    GatewayIp6 string
    Gateway IPv6 address used to probe the server.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    HaPriority int
    HA election priority (1 - 50).
    HttpAgent string
    String in the http-agent field in the HTTP header.
    HttpGet string
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    HttpMatch string
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    Interval int
    Detection interval (1 - 3600 sec, default = 5).
    Name string
    Link monitor name.
    PacketSize int
    Packet size of a twamp test session,
    Password string
    Twamp controller password in authentication mode
    Port int
    Port number of the traffic to be used to monitor the server.
    ProbeCount int
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    ProbeTimeout int
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    Protocol string
    Protocols used to monitor the server.
    Recoverytime int
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    Routes List<Pulumiverse.Fortios.System.Inputs.LinkmonitorRoute>
    Subnet to monitor. The structure of route block is documented below.
    SecurityMode string
    Twamp controller security mode. Valid values: none, authentication.
    ServerConfig string
    Mode of server configuration. Valid values: default, individual.
    ServerLists List<Pulumiverse.Fortios.System.Inputs.LinkmonitorServerList>
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    ServerType string
    Server type (static or dynamic). Valid values: static, dynamic.
    ServiceDetection string
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    SourceIp string
    Source IP address used in packet to the server.
    SourceIp6 string
    Source IPv6 address used in packet to the server.
    Srcintf string
    Interface that receives the traffic to be monitored.
    Status string
    Enable/disable this link monitor. Valid values: enable, disable.
    UpdateCascadeInterface string
    Enable/disable update cascade interface. Valid values: enable, disable.
    UpdatePolicyRoute string
    Enable/disable updating the policy route. Valid values: enable, disable.
    UpdateStaticRoute string
    Enable/disable updating the static route. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Servers []LinkmonitorServerArgs
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    AddrMode string
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    ClassId int
    Traffic class ID.
    Diffservcode string
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    FailWeight int
    Threshold weight to trigger link failure alert.
    Failtime int
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    GatewayIp string
    Gateway IP address used to probe the server.
    GatewayIp6 string
    Gateway IPv6 address used to probe the server.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    HaPriority int
    HA election priority (1 - 50).
    HttpAgent string
    String in the http-agent field in the HTTP header.
    HttpGet string
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    HttpMatch string
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    Interval int
    Detection interval (1 - 3600 sec, default = 5).
    Name string
    Link monitor name.
    PacketSize int
    Packet size of a twamp test session,
    Password string
    Twamp controller password in authentication mode
    Port int
    Port number of the traffic to be used to monitor the server.
    ProbeCount int
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    ProbeTimeout int
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    Protocol string
    Protocols used to monitor the server.
    Recoverytime int
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    Routes []LinkmonitorRouteArgs
    Subnet to monitor. The structure of route block is documented below.
    SecurityMode string
    Twamp controller security mode. Valid values: none, authentication.
    ServerConfig string
    Mode of server configuration. Valid values: default, individual.
    ServerLists []LinkmonitorServerListArgs
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    ServerType string
    Server type (static or dynamic). Valid values: static, dynamic.
    ServiceDetection string
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    SourceIp string
    Source IP address used in packet to the server.
    SourceIp6 string
    Source IPv6 address used in packet to the server.
    Srcintf string
    Interface that receives the traffic to be monitored.
    Status string
    Enable/disable this link monitor. Valid values: enable, disable.
    UpdateCascadeInterface string
    Enable/disable update cascade interface. Valid values: enable, disable.
    UpdatePolicyRoute string
    Enable/disable updating the policy route. Valid values: enable, disable.
    UpdateStaticRoute string
    Enable/disable updating the static route. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    servers List<LinkmonitorServer>
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    addrMode String
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    classId Integer
    Traffic class ID.
    diffservcode String
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    failWeight Integer
    Threshold weight to trigger link failure alert.
    failtime Integer
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    gatewayIp String
    Gateway IP address used to probe the server.
    gatewayIp6 String
    Gateway IPv6 address used to probe the server.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    haPriority Integer
    HA election priority (1 - 50).
    httpAgent String
    String in the http-agent field in the HTTP header.
    httpGet String
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    httpMatch String
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    interval Integer
    Detection interval (1 - 3600 sec, default = 5).
    name String
    Link monitor name.
    packetSize Integer
    Packet size of a twamp test session,
    password String
    Twamp controller password in authentication mode
    port Integer
    Port number of the traffic to be used to monitor the server.
    probeCount Integer
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    probeTimeout Integer
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    protocol String
    Protocols used to monitor the server.
    recoverytime Integer
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    routes List<LinkmonitorRoute>
    Subnet to monitor. The structure of route block is documented below.
    securityMode String
    Twamp controller security mode. Valid values: none, authentication.
    serverConfig String
    Mode of server configuration. Valid values: default, individual.
    serverLists List<LinkmonitorServerList>
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    serverType String
    Server type (static or dynamic). Valid values: static, dynamic.
    serviceDetection String
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    sourceIp String
    Source IP address used in packet to the server.
    sourceIp6 String
    Source IPv6 address used in packet to the server.
    srcintf String
    Interface that receives the traffic to be monitored.
    status String
    Enable/disable this link monitor. Valid values: enable, disable.
    updateCascadeInterface String
    Enable/disable update cascade interface. Valid values: enable, disable.
    updatePolicyRoute String
    Enable/disable updating the policy route. Valid values: enable, disable.
    updateStaticRoute String
    Enable/disable updating the static route. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    servers LinkmonitorServer[]
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    addrMode string
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    classId number
    Traffic class ID.
    diffservcode string
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    failWeight number
    Threshold weight to trigger link failure alert.
    failtime number
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    gatewayIp string
    Gateway IP address used to probe the server.
    gatewayIp6 string
    Gateway IPv6 address used to probe the server.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    haPriority number
    HA election priority (1 - 50).
    httpAgent string
    String in the http-agent field in the HTTP header.
    httpGet string
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    httpMatch string
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    interval number
    Detection interval (1 - 3600 sec, default = 5).
    name string
    Link monitor name.
    packetSize number
    Packet size of a twamp test session,
    password string
    Twamp controller password in authentication mode
    port number
    Port number of the traffic to be used to monitor the server.
    probeCount number
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    probeTimeout number
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    protocol string
    Protocols used to monitor the server.
    recoverytime number
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    routes LinkmonitorRoute[]
    Subnet to monitor. The structure of route block is documented below.
    securityMode string
    Twamp controller security mode. Valid values: none, authentication.
    serverConfig string
    Mode of server configuration. Valid values: default, individual.
    serverLists LinkmonitorServerList[]
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    serverType string
    Server type (static or dynamic). Valid values: static, dynamic.
    serviceDetection string
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    sourceIp string
    Source IP address used in packet to the server.
    sourceIp6 string
    Source IPv6 address used in packet to the server.
    srcintf string
    Interface that receives the traffic to be monitored.
    status string
    Enable/disable this link monitor. Valid values: enable, disable.
    updateCascadeInterface string
    Enable/disable update cascade interface. Valid values: enable, disable.
    updatePolicyRoute string
    Enable/disable updating the policy route. Valid values: enable, disable.
    updateStaticRoute string
    Enable/disable updating the static route. Valid values: enable, disable.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    servers Sequence[LinkmonitorServerArgs]
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    addr_mode str
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    class_id int
    Traffic class ID.
    diffservcode str
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fail_weight int
    Threshold weight to trigger link failure alert.
    failtime int
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    gateway_ip str
    Gateway IP address used to probe the server.
    gateway_ip6 str
    Gateway IPv6 address used to probe the server.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    ha_priority int
    HA election priority (1 - 50).
    http_agent str
    String in the http-agent field in the HTTP header.
    http_get str
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    http_match str
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    interval int
    Detection interval (1 - 3600 sec, default = 5).
    name str
    Link monitor name.
    packet_size int
    Packet size of a twamp test session,
    password str
    Twamp controller password in authentication mode
    port int
    Port number of the traffic to be used to monitor the server.
    probe_count int
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    probe_timeout int
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    protocol str
    Protocols used to monitor the server.
    recoverytime int
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    routes Sequence[LinkmonitorRouteArgs]
    Subnet to monitor. The structure of route block is documented below.
    security_mode str
    Twamp controller security mode. Valid values: none, authentication.
    server_config str
    Mode of server configuration. Valid values: default, individual.
    server_lists Sequence[LinkmonitorServerListArgs]
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    server_type str
    Server type (static or dynamic). Valid values: static, dynamic.
    service_detection str
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    source_ip str
    Source IP address used in packet to the server.
    source_ip6 str
    Source IPv6 address used in packet to the server.
    srcintf str
    Interface that receives the traffic to be monitored.
    status str
    Enable/disable this link monitor. Valid values: enable, disable.
    update_cascade_interface str
    Enable/disable update cascade interface. Valid values: enable, disable.
    update_policy_route str
    Enable/disable updating the policy route. Valid values: enable, disable.
    update_static_route str
    Enable/disable updating the static route. Valid values: enable, disable.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    servers List<Property Map>
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    addrMode String
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    classId Number
    Traffic class ID.
    diffservcode String
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    failWeight Number
    Threshold weight to trigger link failure alert.
    failtime Number
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    gatewayIp String
    Gateway IP address used to probe the server.
    gatewayIp6 String
    Gateway IPv6 address used to probe the server.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    haPriority Number
    HA election priority (1 - 50).
    httpAgent String
    String in the http-agent field in the HTTP header.
    httpGet String
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    httpMatch String
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    interval Number
    Detection interval (1 - 3600 sec, default = 5).
    name String
    Link monitor name.
    packetSize Number
    Packet size of a twamp test session,
    password String
    Twamp controller password in authentication mode
    port Number
    Port number of the traffic to be used to monitor the server.
    probeCount Number
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    probeTimeout Number
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    protocol String
    Protocols used to monitor the server.
    recoverytime Number
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    routes List<Property Map>
    Subnet to monitor. The structure of route block is documented below.
    securityMode String
    Twamp controller security mode. Valid values: none, authentication.
    serverConfig String
    Mode of server configuration. Valid values: default, individual.
    serverLists List<Property Map>
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    serverType String
    Server type (static or dynamic). Valid values: static, dynamic.
    serviceDetection String
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    sourceIp String
    Source IP address used in packet to the server.
    sourceIp6 String
    Source IPv6 address used in packet to the server.
    srcintf String
    Interface that receives the traffic to be monitored.
    status String
    Enable/disable this link monitor. Valid values: enable, disable.
    updateCascadeInterface String
    Enable/disable update cascade interface. Valid values: enable, disable.
    updatePolicyRoute String
    Enable/disable updating the policy route. Valid values: enable, disable.
    updateStaticRoute String
    Enable/disable updating the static route. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

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

    Get an existing Linkmonitor 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?: LinkmonitorState, opts?: CustomResourceOptions): Linkmonitor
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addr_mode: Optional[str] = None,
        class_id: Optional[int] = None,
        diffservcode: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        fail_weight: Optional[int] = None,
        failtime: Optional[int] = None,
        gateway_ip: Optional[str] = None,
        gateway_ip6: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        ha_priority: Optional[int] = None,
        http_agent: Optional[str] = None,
        http_get: Optional[str] = None,
        http_match: Optional[str] = None,
        interval: Optional[int] = None,
        name: Optional[str] = None,
        packet_size: Optional[int] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        probe_count: Optional[int] = None,
        probe_timeout: Optional[int] = None,
        protocol: Optional[str] = None,
        recoverytime: Optional[int] = None,
        routes: Optional[Sequence[LinkmonitorRouteArgs]] = None,
        security_mode: Optional[str] = None,
        server_config: Optional[str] = None,
        server_lists: Optional[Sequence[LinkmonitorServerListArgs]] = None,
        server_type: Optional[str] = None,
        servers: Optional[Sequence[LinkmonitorServerArgs]] = None,
        service_detection: Optional[str] = None,
        source_ip: Optional[str] = None,
        source_ip6: Optional[str] = None,
        srcintf: Optional[str] = None,
        status: Optional[str] = None,
        update_cascade_interface: Optional[str] = None,
        update_policy_route: Optional[str] = None,
        update_static_route: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Linkmonitor
    func GetLinkmonitor(ctx *Context, name string, id IDInput, state *LinkmonitorState, opts ...ResourceOption) (*Linkmonitor, error)
    public static Linkmonitor Get(string name, Input<string> id, LinkmonitorState? state, CustomResourceOptions? opts = null)
    public static Linkmonitor get(String name, Output<String> id, LinkmonitorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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.
    ClassId int
    Traffic class ID.
    Diffservcode string
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    FailWeight int
    Threshold weight to trigger link failure alert.
    Failtime int
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    GatewayIp string
    Gateway IP address used to probe the server.
    GatewayIp6 string
    Gateway IPv6 address used to probe the server.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    HaPriority int
    HA election priority (1 - 50).
    HttpAgent string
    String in the http-agent field in the HTTP header.
    HttpGet string
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    HttpMatch string
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    Interval int
    Detection interval (1 - 3600 sec, default = 5).
    Name string
    Link monitor name.
    PacketSize int
    Packet size of a twamp test session,
    Password string
    Twamp controller password in authentication mode
    Port int
    Port number of the traffic to be used to monitor the server.
    ProbeCount int
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    ProbeTimeout int
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    Protocol string
    Protocols used to monitor the server.
    Recoverytime int
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    Routes List<Pulumiverse.Fortios.System.Inputs.LinkmonitorRoute>
    Subnet to monitor. The structure of route block is documented below.
    SecurityMode string
    Twamp controller security mode. Valid values: none, authentication.
    ServerConfig string
    Mode of server configuration. Valid values: default, individual.
    ServerLists List<Pulumiverse.Fortios.System.Inputs.LinkmonitorServerList>
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    ServerType string
    Server type (static or dynamic). Valid values: static, dynamic.
    Servers List<Pulumiverse.Fortios.System.Inputs.LinkmonitorServer>
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    ServiceDetection string
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    SourceIp string
    Source IP address used in packet to the server.
    SourceIp6 string
    Source IPv6 address used in packet to the server.
    Srcintf string
    Interface that receives the traffic to be monitored.
    Status string
    Enable/disable this link monitor. Valid values: enable, disable.
    UpdateCascadeInterface string
    Enable/disable update cascade interface. Valid values: enable, disable.
    UpdatePolicyRoute string
    Enable/disable updating the policy route. Valid values: enable, disable.
    UpdateStaticRoute string
    Enable/disable updating the static route. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    AddrMode string
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    ClassId int
    Traffic class ID.
    Diffservcode string
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    FailWeight int
    Threshold weight to trigger link failure alert.
    Failtime int
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    GatewayIp string
    Gateway IP address used to probe the server.
    GatewayIp6 string
    Gateway IPv6 address used to probe the server.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    HaPriority int
    HA election priority (1 - 50).
    HttpAgent string
    String in the http-agent field in the HTTP header.
    HttpGet string
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    HttpMatch string
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    Interval int
    Detection interval (1 - 3600 sec, default = 5).
    Name string
    Link monitor name.
    PacketSize int
    Packet size of a twamp test session,
    Password string
    Twamp controller password in authentication mode
    Port int
    Port number of the traffic to be used to monitor the server.
    ProbeCount int
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    ProbeTimeout int
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    Protocol string
    Protocols used to monitor the server.
    Recoverytime int
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    Routes []LinkmonitorRouteArgs
    Subnet to monitor. The structure of route block is documented below.
    SecurityMode string
    Twamp controller security mode. Valid values: none, authentication.
    ServerConfig string
    Mode of server configuration. Valid values: default, individual.
    ServerLists []LinkmonitorServerListArgs
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    ServerType string
    Server type (static or dynamic). Valid values: static, dynamic.
    Servers []LinkmonitorServerArgs
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    ServiceDetection string
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    SourceIp string
    Source IP address used in packet to the server.
    SourceIp6 string
    Source IPv6 address used in packet to the server.
    Srcintf string
    Interface that receives the traffic to be monitored.
    Status string
    Enable/disable this link monitor. Valid values: enable, disable.
    UpdateCascadeInterface string
    Enable/disable update cascade interface. Valid values: enable, disable.
    UpdatePolicyRoute string
    Enable/disable updating the policy route. Valid values: enable, disable.
    UpdateStaticRoute string
    Enable/disable updating the static route. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addrMode String
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    classId Integer
    Traffic class ID.
    diffservcode String
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    failWeight Integer
    Threshold weight to trigger link failure alert.
    failtime Integer
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    gatewayIp String
    Gateway IP address used to probe the server.
    gatewayIp6 String
    Gateway IPv6 address used to probe the server.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    haPriority Integer
    HA election priority (1 - 50).
    httpAgent String
    String in the http-agent field in the HTTP header.
    httpGet String
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    httpMatch String
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    interval Integer
    Detection interval (1 - 3600 sec, default = 5).
    name String
    Link monitor name.
    packetSize Integer
    Packet size of a twamp test session,
    password String
    Twamp controller password in authentication mode
    port Integer
    Port number of the traffic to be used to monitor the server.
    probeCount Integer
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    probeTimeout Integer
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    protocol String
    Protocols used to monitor the server.
    recoverytime Integer
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    routes List<LinkmonitorRoute>
    Subnet to monitor. The structure of route block is documented below.
    securityMode String
    Twamp controller security mode. Valid values: none, authentication.
    serverConfig String
    Mode of server configuration. Valid values: default, individual.
    serverLists List<LinkmonitorServerList>
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    serverType String
    Server type (static or dynamic). Valid values: static, dynamic.
    servers List<LinkmonitorServer>
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    serviceDetection String
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    sourceIp String
    Source IP address used in packet to the server.
    sourceIp6 String
    Source IPv6 address used in packet to the server.
    srcintf String
    Interface that receives the traffic to be monitored.
    status String
    Enable/disable this link monitor. Valid values: enable, disable.
    updateCascadeInterface String
    Enable/disable update cascade interface. Valid values: enable, disable.
    updatePolicyRoute String
    Enable/disable updating the policy route. Valid values: enable, disable.
    updateStaticRoute String
    Enable/disable updating the static route. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addrMode string
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    classId number
    Traffic class ID.
    diffservcode string
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    failWeight number
    Threshold weight to trigger link failure alert.
    failtime number
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    gatewayIp string
    Gateway IP address used to probe the server.
    gatewayIp6 string
    Gateway IPv6 address used to probe the server.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    haPriority number
    HA election priority (1 - 50).
    httpAgent string
    String in the http-agent field in the HTTP header.
    httpGet string
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    httpMatch string
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    interval number
    Detection interval (1 - 3600 sec, default = 5).
    name string
    Link monitor name.
    packetSize number
    Packet size of a twamp test session,
    password string
    Twamp controller password in authentication mode
    port number
    Port number of the traffic to be used to monitor the server.
    probeCount number
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    probeTimeout number
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    protocol string
    Protocols used to monitor the server.
    recoverytime number
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    routes LinkmonitorRoute[]
    Subnet to monitor. The structure of route block is documented below.
    securityMode string
    Twamp controller security mode. Valid values: none, authentication.
    serverConfig string
    Mode of server configuration. Valid values: default, individual.
    serverLists LinkmonitorServerList[]
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    serverType string
    Server type (static or dynamic). Valid values: static, dynamic.
    servers LinkmonitorServer[]
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    serviceDetection string
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    sourceIp string
    Source IP address used in packet to the server.
    sourceIp6 string
    Source IPv6 address used in packet to the server.
    srcintf string
    Interface that receives the traffic to be monitored.
    status string
    Enable/disable this link monitor. Valid values: enable, disable.
    updateCascadeInterface string
    Enable/disable update cascade interface. Valid values: enable, disable.
    updatePolicyRoute string
    Enable/disable updating the policy route. Valid values: enable, disable.
    updateStaticRoute string
    Enable/disable updating the static route. Valid values: enable, disable.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addr_mode str
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    class_id int
    Traffic class ID.
    diffservcode str
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    fail_weight int
    Threshold weight to trigger link failure alert.
    failtime int
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    gateway_ip str
    Gateway IP address used to probe the server.
    gateway_ip6 str
    Gateway IPv6 address used to probe the server.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    ha_priority int
    HA election priority (1 - 50).
    http_agent str
    String in the http-agent field in the HTTP header.
    http_get str
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    http_match str
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    interval int
    Detection interval (1 - 3600 sec, default = 5).
    name str
    Link monitor name.
    packet_size int
    Packet size of a twamp test session,
    password str
    Twamp controller password in authentication mode
    port int
    Port number of the traffic to be used to monitor the server.
    probe_count int
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    probe_timeout int
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    protocol str
    Protocols used to monitor the server.
    recoverytime int
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    routes Sequence[LinkmonitorRouteArgs]
    Subnet to monitor. The structure of route block is documented below.
    security_mode str
    Twamp controller security mode. Valid values: none, authentication.
    server_config str
    Mode of server configuration. Valid values: default, individual.
    server_lists Sequence[LinkmonitorServerListArgs]
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    server_type str
    Server type (static or dynamic). Valid values: static, dynamic.
    servers Sequence[LinkmonitorServerArgs]
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    service_detection str
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    source_ip str
    Source IP address used in packet to the server.
    source_ip6 str
    Source IPv6 address used in packet to the server.
    srcintf str
    Interface that receives the traffic to be monitored.
    status str
    Enable/disable this link monitor. Valid values: enable, disable.
    update_cascade_interface str
    Enable/disable update cascade interface. Valid values: enable, disable.
    update_policy_route str
    Enable/disable updating the policy route. Valid values: enable, disable.
    update_static_route str
    Enable/disable updating the static route. Valid values: enable, disable.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    addrMode String
    Address mode (IPv4 or IPv6). Valid values: ipv4, ipv6.
    classId Number
    Traffic class ID.
    diffservcode String
    Differentiated services code point (DSCP) in the IP header of the probe packet.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    failWeight Number
    Threshold weight to trigger link failure alert.
    failtime Number
    Number of retry attempts before the server is considered down (1 - 10, default = 5)
    gatewayIp String
    Gateway IP address used to probe the server.
    gatewayIp6 String
    Gateway IPv6 address used to probe the server.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    haPriority Number
    HA election priority (1 - 50).
    httpAgent String
    String in the http-agent field in the HTTP header.
    httpGet String
    If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string.
    httpMatch String
    String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
    interval Number
    Detection interval (1 - 3600 sec, default = 5).
    name String
    Link monitor name.
    packetSize Number
    Packet size of a twamp test session,
    password String
    Twamp controller password in authentication mode
    port Number
    Port number of the traffic to be used to monitor the server.
    probeCount Number
    Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
    probeTimeout Number
    Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500).
    protocol String
    Protocols used to monitor the server.
    recoverytime Number
    Number of successful responses received before server is considered recovered (1 - 10, default = 5).
    routes List<Property Map>
    Subnet to monitor. The structure of route block is documented below.
    securityMode String
    Twamp controller security mode. Valid values: none, authentication.
    serverConfig String
    Mode of server configuration. Valid values: default, individual.
    serverLists List<Property Map>
    Servers for link-monitor to monitor. The structure of server_list block is documented below.
    serverType String
    Server type (static or dynamic). Valid values: static, dynamic.
    servers List<Property Map>
    IP address of the server(s) to be monitored. The structure of server block is documented below.
    serviceDetection String
    Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values: enable, disable.
    sourceIp String
    Source IP address used in packet to the server.
    sourceIp6 String
    Source IPv6 address used in packet to the server.
    srcintf String
    Interface that receives the traffic to be monitored.
    status String
    Enable/disable this link monitor. Valid values: enable, disable.
    updateCascadeInterface String
    Enable/disable update cascade interface. Valid values: enable, disable.
    updatePolicyRoute String
    Enable/disable updating the policy route. Valid values: enable, disable.
    updateStaticRoute String
    Enable/disable updating the static route. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Supporting Types

    LinkmonitorRoute, LinkmonitorRouteArgs

    Subnet string
    IP and netmask (x.x.x.x/y).
    Subnet string
    IP and netmask (x.x.x.x/y).
    subnet String
    IP and netmask (x.x.x.x/y).
    subnet string
    IP and netmask (x.x.x.x/y).
    subnet str
    IP and netmask (x.x.x.x/y).
    subnet String
    IP and netmask (x.x.x.x/y).

    LinkmonitorServer, LinkmonitorServerArgs

    Address string
    Server address.
    Address string
    Server address.
    address String
    Server address.
    address string
    Server address.
    address str
    Server address.
    address String
    Server address.

    LinkmonitorServerList, LinkmonitorServerListArgs

    Dst string
    IP address of the server to be monitored.
    Id int
    Server ID.
    Port int
    Port number of the traffic to be used to monitor the server.
    Protocol string
    Protocols used to monitor the server.
    Weight int
    Weight of the monitor to this dst (0 - 255).
    Dst string
    IP address of the server to be monitored.
    Id int
    Server ID.
    Port int
    Port number of the traffic to be used to monitor the server.
    Protocol string
    Protocols used to monitor the server.
    Weight int
    Weight of the monitor to this dst (0 - 255).
    dst String
    IP address of the server to be monitored.
    id Integer
    Server ID.
    port Integer
    Port number of the traffic to be used to monitor the server.
    protocol String
    Protocols used to monitor the server.
    weight Integer
    Weight of the monitor to this dst (0 - 255).
    dst string
    IP address of the server to be monitored.
    id number
    Server ID.
    port number
    Port number of the traffic to be used to monitor the server.
    protocol string
    Protocols used to monitor the server.
    weight number
    Weight of the monitor to this dst (0 - 255).
    dst str
    IP address of the server to be monitored.
    id int
    Server ID.
    port int
    Port number of the traffic to be used to monitor the server.
    protocol str
    Protocols used to monitor the server.
    weight int
    Weight of the monitor to this dst (0 - 255).
    dst String
    IP address of the server to be monitored.
    id Number
    Server ID.
    port Number
    Port number of the traffic to be used to monitor the server.
    protocol String
    Protocols used to monitor the server.
    weight Number
    Weight of the monitor to this dst (0 - 255).

    Import

    System LinkMonitor can be imported using any of these accepted formats:

    $ pulumi import fortios:system/linkmonitor:Linkmonitor labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/linkmonitor:Linkmonitor labelname {{name}}

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios