fortios.system.Linkmonitor
Explore with Pulumi AI
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=[{
"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=[{
"subnet": "string",
}],
security_mode="string",
server_config="string",
server_lists=[{
"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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Linkmonitor resource accepts the following input properties:
- Servers
List<Pulumiverse.
Fortios. System. Inputs. Linkmonitor Server> - IP address of the server(s) to be monitored. The structure of
server
block is documented below. - Addr
Mode string - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - Class
Id int - Traffic class ID.
- Diffservcode string
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- Dynamic
Sort stringSubtable - 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 (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- Gateway
Ip string - Gateway IP address used to probe the server.
- Gateway
Ip6 string - Gateway IPv6 address used to probe the server.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 string - String in the http-agent field in the HTTP header.
- Http
Get 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.
- Http
Match string - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- Interval int
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- Name string
- Link monitor name.
- Packet
Size 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.
- 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 (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- Protocol string
- Protocols used to monitor the server.
- Recoverytime int
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- Routes
List<Pulumiverse.
Fortios. System. Inputs. Linkmonitor Route> - Subnet to monitor. The structure of
route
block is documented below. - Security
Mode string - Twamp controller security mode. Valid values:
none
,authentication
. - Server
Config string - Mode of server configuration. Valid values:
default
,individual
. - Server
Lists List<Pulumiverse.Fortios. System. Inputs. Linkmonitor Server List> - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - Server
Type string - Server type (static or dynamic). Valid values:
static
,dynamic
. - Service
Detection string - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - Source
Ip string - Source IP address used in packet to the server.
- Source
Ip6 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
. - Update
Cascade stringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - Update
Policy stringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - Update
Static stringRoute - 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
[]Linkmonitor
Server Args - IP address of the server(s) to be monitored. The structure of
server
block is documented below. - Addr
Mode string - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - Class
Id int - Traffic class ID.
- Diffservcode string
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- Dynamic
Sort stringSubtable - 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 (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- Gateway
Ip string - Gateway IP address used to probe the server.
- Gateway
Ip6 string - Gateway IPv6 address used to probe the server.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 string - String in the http-agent field in the HTTP header.
- Http
Get 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.
- Http
Match string - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- Interval int
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- Name string
- Link monitor name.
- Packet
Size 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.
- 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 (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- Protocol string
- Protocols used to monitor the server.
- Recoverytime int
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- Routes
[]Linkmonitor
Route Args - Subnet to monitor. The structure of
route
block is documented below. - Security
Mode string - Twamp controller security mode. Valid values:
none
,authentication
. - Server
Config string - Mode of server configuration. Valid values:
default
,individual
. - Server
Lists []LinkmonitorServer List Args - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - Server
Type string - Server type (static or dynamic). Valid values:
static
,dynamic
. - Service
Detection string - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - Source
Ip string - Source IP address used in packet to the server.
- Source
Ip6 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
. - Update
Cascade stringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - Update
Policy stringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - Update
Static stringRoute - 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<Linkmonitor
Server> - IP address of the server(s) to be monitored. The structure of
server
block is documented below. - addr
Mode String - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - class
Id Integer - Traffic class ID.
- diffservcode String
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- dynamic
Sort StringSubtable - 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 Integer - Threshold weight to trigger link failure alert.
- failtime Integer
- Number of retry attempts before the server is considered down (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- gateway
Ip String - Gateway IP address used to probe the server.
- gateway
Ip6 String - Gateway IPv6 address used to probe the server.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 Integer - HA election priority (1 - 50).
- http
Agent String - String in the http-agent field in the HTTP header.
- http
Get 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.
- http
Match String - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- interval Integer
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- name String
- Link monitor name.
- packet
Size 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.
- probe
Count Integer - Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
- probe
Timeout Integer - Time to wait before a probe packet is considered lost (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- protocol String
- Protocols used to monitor the server.
- recoverytime Integer
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- routes
List<Linkmonitor
Route> - Subnet to monitor. The structure of
route
block is documented below. - security
Mode String - Twamp controller security mode. Valid values:
none
,authentication
. - server
Config String - Mode of server configuration. Valid values:
default
,individual
. - server
Lists List<LinkmonitorServer List> - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - server
Type String - Server type (static or dynamic). Valid values:
static
,dynamic
. - service
Detection String - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - source
Ip String - Source IP address used in packet to the server.
- source
Ip6 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
. - update
Cascade StringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - update
Policy StringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - update
Static StringRoute - 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
Linkmonitor
Server[] - IP address of the server(s) to be monitored. The structure of
server
block is documented below. - addr
Mode string - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - class
Id number - Traffic class ID.
- diffservcode string
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- dynamic
Sort stringSubtable - 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 number - Threshold weight to trigger link failure alert.
- failtime number
- Number of retry attempts before the server is considered down (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- gateway
Ip string - Gateway IP address used to probe the server.
- gateway
Ip6 string - Gateway IPv6 address used to probe the server.
- get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 number - HA election priority (1 - 50).
- http
Agent string - String in the http-agent field in the HTTP header.
- http
Get 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.
- http
Match string - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- interval number
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- name string
- Link monitor name.
- packet
Size 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.
- probe
Count number - Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
- probe
Timeout number - Time to wait before a probe packet is considered lost (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- protocol string
- Protocols used to monitor the server.
- recoverytime number
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- routes
Linkmonitor
Route[] - Subnet to monitor. The structure of
route
block is documented below. - security
Mode string - Twamp controller security mode. Valid values:
none
,authentication
. - server
Config string - Mode of server configuration. Valid values:
default
,individual
. - server
Lists LinkmonitorServer List[] - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - server
Type string - Server type (static or dynamic). Valid values:
static
,dynamic
. - service
Detection string - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - source
Ip string - Source IP address used in packet to the server.
- source
Ip6 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
. - update
Cascade stringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - update
Policy stringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - update
Static stringRoute - 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[Linkmonitor
Server Args] - 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_ strsubtable - 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 (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- gateway_
ip str - Gateway IP address used to probe the server.
- gateway_
ip6 str - Gateway IPv6 address used to probe the server.
- get_
all_ strtables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- 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 (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- protocol str
- Protocols used to monitor the server.
- recoverytime int
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- routes
Sequence[Linkmonitor
Route Args] - 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[LinkmonitorServer List Args] - 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_ strinterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - update_
policy_ strroute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - update_
static_ strroute - 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. - addr
Mode String - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - class
Id Number - Traffic class ID.
- diffservcode String
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- dynamic
Sort StringSubtable - 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 Number - Threshold weight to trigger link failure alert.
- failtime Number
- Number of retry attempts before the server is considered down (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- gateway
Ip String - Gateway IP address used to probe the server.
- gateway
Ip6 String - Gateway IPv6 address used to probe the server.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 Number - HA election priority (1 - 50).
- http
Agent String - String in the http-agent field in the HTTP header.
- http
Get 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.
- http
Match String - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- interval Number
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- name String
- Link monitor name.
- packet
Size 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.
- probe
Count Number - Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
- probe
Timeout Number - Time to wait before a probe packet is considered lost (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- protocol String
- Protocols used to monitor the server.
- recoverytime Number
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- routes List<Property Map>
- Subnet to monitor. The structure of
route
block is documented below. - security
Mode String - Twamp controller security mode. Valid values:
none
,authentication
. - server
Config String - Mode of server configuration. Valid values:
default
,individual
. - server
Lists List<Property Map> - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - server
Type String - Server type (static or dynamic). Valid values:
static
,dynamic
. - service
Detection String - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - source
Ip String - Source IP address used in packet to the server.
- source
Ip6 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
. - update
Cascade StringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - update
Policy StringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - update
Static StringRoute - 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.
- Addr
Mode string - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - Class
Id int - Traffic class ID.
- Diffservcode string
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- Dynamic
Sort stringSubtable - 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 (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- Gateway
Ip string - Gateway IP address used to probe the server.
- Gateway
Ip6 string - Gateway IPv6 address used to probe the server.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 string - String in the http-agent field in the HTTP header.
- Http
Get 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.
- Http
Match string - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- Interval int
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- Name string
- Link monitor name.
- Packet
Size 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.
- 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 (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- Protocol string
- Protocols used to monitor the server.
- Recoverytime int
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- Routes
List<Pulumiverse.
Fortios. System. Inputs. Linkmonitor Route> - Subnet to monitor. The structure of
route
block is documented below. - Security
Mode string - Twamp controller security mode. Valid values:
none
,authentication
. - Server
Config string - Mode of server configuration. Valid values:
default
,individual
. - Server
Lists List<Pulumiverse.Fortios. System. Inputs. Linkmonitor Server List> - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - Server
Type string - Server type (static or dynamic). Valid values:
static
,dynamic
. - Servers
List<Pulumiverse.
Fortios. System. Inputs. Linkmonitor Server> - IP address of the server(s) to be monitored. The structure of
server
block is documented below. - Service
Detection string - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - Source
Ip string - Source IP address used in packet to the server.
- Source
Ip6 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
. - Update
Cascade stringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - Update
Policy stringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - Update
Static stringRoute - 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 string - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - Class
Id int - Traffic class ID.
- Diffservcode string
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- Dynamic
Sort stringSubtable - 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 (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- Gateway
Ip string - Gateway IP address used to probe the server.
- Gateway
Ip6 string - Gateway IPv6 address used to probe the server.
- Get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 string - String in the http-agent field in the HTTP header.
- Http
Get 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.
- Http
Match string - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- Interval int
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- Name string
- Link monitor name.
- Packet
Size 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.
- 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 (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- Protocol string
- Protocols used to monitor the server.
- Recoverytime int
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- Routes
[]Linkmonitor
Route Args - Subnet to monitor. The structure of
route
block is documented below. - Security
Mode string - Twamp controller security mode. Valid values:
none
,authentication
. - Server
Config string - Mode of server configuration. Valid values:
default
,individual
. - Server
Lists []LinkmonitorServer List Args - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - Server
Type string - Server type (static or dynamic). Valid values:
static
,dynamic
. - Servers
[]Linkmonitor
Server Args - IP address of the server(s) to be monitored. The structure of
server
block is documented below. - Service
Detection string - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - Source
Ip string - Source IP address used in packet to the server.
- Source
Ip6 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
. - Update
Cascade stringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - Update
Policy stringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - Update
Static stringRoute - 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 String - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - class
Id Integer - Traffic class ID.
- diffservcode String
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- dynamic
Sort StringSubtable - 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 Integer - Threshold weight to trigger link failure alert.
- failtime Integer
- Number of retry attempts before the server is considered down (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- gateway
Ip String - Gateway IP address used to probe the server.
- gateway
Ip6 String - Gateway IPv6 address used to probe the server.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 Integer - HA election priority (1 - 50).
- http
Agent String - String in the http-agent field in the HTTP header.
- http
Get 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.
- http
Match String - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- interval Integer
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- name String
- Link monitor name.
- packet
Size 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.
- probe
Count Integer - Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
- probe
Timeout Integer - Time to wait before a probe packet is considered lost (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- protocol String
- Protocols used to monitor the server.
- recoverytime Integer
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- routes
List<Linkmonitor
Route> - Subnet to monitor. The structure of
route
block is documented below. - security
Mode String - Twamp controller security mode. Valid values:
none
,authentication
. - server
Config String - Mode of server configuration. Valid values:
default
,individual
. - server
Lists List<LinkmonitorServer List> - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - server
Type String - Server type (static or dynamic). Valid values:
static
,dynamic
. - servers
List<Linkmonitor
Server> - IP address of the server(s) to be monitored. The structure of
server
block is documented below. - service
Detection String - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - source
Ip String - Source IP address used in packet to the server.
- source
Ip6 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
. - update
Cascade StringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - update
Policy StringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - update
Static StringRoute - 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 string - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - class
Id number - Traffic class ID.
- diffservcode string
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- dynamic
Sort stringSubtable - 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 number - Threshold weight to trigger link failure alert.
- failtime number
- Number of retry attempts before the server is considered down (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- gateway
Ip string - Gateway IP address used to probe the server.
- gateway
Ip6 string - Gateway IPv6 address used to probe the server.
- get
All stringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 number - HA election priority (1 - 50).
- http
Agent string - String in the http-agent field in the HTTP header.
- http
Get 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.
- http
Match string - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- interval number
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- name string
- Link monitor name.
- packet
Size 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.
- probe
Count number - Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
- probe
Timeout number - Time to wait before a probe packet is considered lost (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- protocol string
- Protocols used to monitor the server.
- recoverytime number
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- routes
Linkmonitor
Route[] - Subnet to monitor. The structure of
route
block is documented below. - security
Mode string - Twamp controller security mode. Valid values:
none
,authentication
. - server
Config string - Mode of server configuration. Valid values:
default
,individual
. - server
Lists LinkmonitorServer List[] - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - server
Type string - Server type (static or dynamic). Valid values:
static
,dynamic
. - servers
Linkmonitor
Server[] - IP address of the server(s) to be monitored. The structure of
server
block is documented below. - service
Detection string - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - source
Ip string - Source IP address used in packet to the server.
- source
Ip6 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
. - update
Cascade stringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - update
Policy stringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - update
Static stringRoute - 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_ strsubtable - 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 (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- gateway_
ip str - Gateway IP address used to probe the server.
- gateway_
ip6 str - Gateway IPv6 address used to probe the server.
- get_
all_ strtables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- 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 (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- protocol str
- Protocols used to monitor the server.
- recoverytime int
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- routes
Sequence[Linkmonitor
Route Args] - 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[LinkmonitorServer List Args] - 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[Linkmonitor
Server Args] - 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_ strinterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - update_
policy_ strroute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - update_
static_ strroute - 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.
- addr
Mode String - Address mode (IPv4 or IPv6). Valid values:
ipv4
,ipv6
. - class
Id Number - Traffic class ID.
- diffservcode String
- Differentiated services code point (DSCP) in the IP header of the probe packet.
- dynamic
Sort StringSubtable - 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 Number - Threshold weight to trigger link failure alert.
- failtime Number
- Number of retry attempts before the server is considered down (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- gateway
Ip String - Gateway IP address used to probe the server.
- gateway
Ip6 String - Gateway IPv6 address used to probe the server.
- get
All StringTables - Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, 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 Number - HA election priority (1 - 50).
- http
Agent String - String in the http-agent field in the HTTP header.
- http
Get 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.
- http
Match String - String that you expect to see in the HTTP-GET requests of the traffic to be monitored.
- interval Number
- Detection interval. On FortiOS versions 6.2.0: 1 - 3600 sec, default = 5. On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 3600 * 1000 msec, default = 500. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 3600 * 1000 msec, default = 500.
- name String
- Link monitor name.
- packet
Size 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.
- probe
Count Number - Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30).
- probe
Timeout Number - Time to wait before a probe packet is considered lost (default = 500). On FortiOS versions 6.2.4-7.0.10, 7.2.0-7.2.4: 500 - 5000 msec. On FortiOS versions 7.0.11-7.0.15, >= 7.2.6: 20 - 5000 msec.
- protocol String
- Protocols used to monitor the server.
- recoverytime Number
- Number of successful responses received before server is considered recovered (default = 5). On FortiOS versions 6.2.0-7.0.5: 1 - 10. On FortiOS versions >= 7.0.6: 1 - 3600.
- routes List<Property Map>
- Subnet to monitor. The structure of
route
block is documented below. - security
Mode String - Twamp controller security mode. Valid values:
none
,authentication
. - server
Config String - Mode of server configuration. Valid values:
default
,individual
. - server
Lists List<Property Map> - Servers for link-monitor to monitor. The structure of
server_list
block is documented below. - server
Type 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. - service
Detection String - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Valid values:
enable
,disable
. - source
Ip String - Source IP address used in packet to the server.
- source
Ip6 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
. - update
Cascade StringInterface - Enable/disable update cascade interface. Valid values:
enable
,disable
. - update
Policy StringRoute - Enable/disable updating the policy route. Valid values:
enable
,disable
. - update
Static StringRoute - 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
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.