Fortios v0.0.5, Apr 9 24

Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.system.getLinkmonitor

Explore with Pulumi AI

Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

Using getLinkmonitor

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLinkmonitor(args: GetLinkmonitorArgs, opts?: InvokeOptions): Promise<GetLinkmonitorResult>
function getLinkmonitorOutput(args: GetLinkmonitorOutputArgs, opts?: InvokeOptions): Output<GetLinkmonitorResult>

def get_linkmonitor(name: Optional[str] = None,
                    vdomparam: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetLinkmonitorResult
def get_linkmonitor_output(name: Optional[pulumi.Input[str]] = None,
                    vdomparam: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetLinkmonitorResult]

func LookupLinkmonitor(ctx *Context, args *LookupLinkmonitorArgs, opts ...InvokeOption) (*LookupLinkmonitorResult, error)
func LookupLinkmonitorOutput(ctx *Context, args *LookupLinkmonitorOutputArgs, opts ...InvokeOption) LookupLinkmonitorResultOutput

> Note: This function is named LookupLinkmonitor in the Go SDK.

public static class GetLinkmonitor 
{
    public static Task<GetLinkmonitorResult> InvokeAsync(GetLinkmonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetLinkmonitorResult> Invoke(GetLinkmonitorInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLinkmonitorResult> getLinkmonitor(GetLinkmonitorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: fortios:system/getLinkmonitor:getLinkmonitor
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Specify the name of the desired system linkmonitor.
Vdomparam string: Specifies the vdom to which the data source 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.

Name string: Specify the name of the desired system linkmonitor.
Vdomparam string: Specifies the vdom to which the data source 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.

name String: Specify the name of the desired system linkmonitor.
vdomparam String: Specifies the vdom to which the data source 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.

name string: Specify the name of the desired system linkmonitor.
vdomparam string: Specifies the vdom to which the data source 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.

name str: Specify the name of the desired system linkmonitor.
vdomparam str: Specifies the vdom to which the data source 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.

name String: Specify the name of the desired system linkmonitor.
vdomparam String: Specifies the vdom to which the data source 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.

getLinkmonitor Result

The following output properties are available:

AddrMode string: Address mode (IPv4 or IPv6).
ClassId int: Traffic class ID.
Diffservcode string: Differentiated services code point (DSCP) in the IP header of the probe packet.
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.
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.
Id string: The provider-assigned unique ID for this managed resource.
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.Outputs.GetLinkmonitorRoute>: Subnet to monitor. The structure of route block is documented below.
SecurityMode string: Twamp controller security mode.
ServerConfig string: Mode of server configuration.
ServerLists List<Pulumiverse.Fortios.System.Outputs.GetLinkmonitorServerList>: Servers for link-monitor to monitor. The structure of server_list block is documented below.
ServerType string: Server type (static or dynamic).
Servers List<Pulumiverse.Fortios.System.Outputs.GetLinkmonitorServer>: 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.
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.
UpdateCascadeInterface string: Enable/disable update cascade interface.
UpdatePolicyRoute string: Enable/disable updating the policy route.
UpdateStaticRoute string: Enable/disable updating the static route.
Vdomparam string

AddrMode string: Address mode (IPv4 or IPv6).
ClassId int: Traffic class ID.
Diffservcode string: Differentiated services code point (DSCP) in the IP header of the probe packet.
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.
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.
Id string: The provider-assigned unique ID for this managed resource.
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 []GetLinkmonitorRoute: Subnet to monitor. The structure of route block is documented below.
SecurityMode string: Twamp controller security mode.
ServerConfig string: Mode of server configuration.
ServerLists []GetLinkmonitorServerList: Servers for link-monitor to monitor. The structure of server_list block is documented below.
ServerType string: Server type (static or dynamic).
Servers []GetLinkmonitorServer: 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.
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.
UpdateCascadeInterface string: Enable/disable update cascade interface.
UpdatePolicyRoute string: Enable/disable updating the policy route.
UpdateStaticRoute string: Enable/disable updating the static route.
Vdomparam string

addrMode String: Address mode (IPv4 or IPv6).
classId Integer: Traffic class ID.
diffservcode String: Differentiated services code point (DSCP) in the IP header of the probe packet.
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.
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.
id String: The provider-assigned unique ID for this managed resource.
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<GetLinkmonitorRoute>: Subnet to monitor. The structure of route block is documented below.
securityMode String: Twamp controller security mode.
serverConfig String: Mode of server configuration.
serverLists List<GetLinkmonitorServerList>: Servers for link-monitor to monitor. The structure of server_list block is documented below.
serverType String: Server type (static or dynamic).
servers List<GetLinkmonitorServer>: 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.
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.
updateCascadeInterface String: Enable/disable update cascade interface.
updatePolicyRoute String: Enable/disable updating the policy route.
updateStaticRoute String: Enable/disable updating the static route.
vdomparam String

addrMode string: Address mode (IPv4 or IPv6).
classId number: Traffic class ID.
diffservcode string: Differentiated services code point (DSCP) in the IP header of the probe packet.
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.
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.
id string: The provider-assigned unique ID for this managed resource.
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 GetLinkmonitorRoute[]: Subnet to monitor. The structure of route block is documented below.
securityMode string: Twamp controller security mode.
serverConfig string: Mode of server configuration.
serverLists GetLinkmonitorServerList[]: Servers for link-monitor to monitor. The structure of server_list block is documented below.
serverType string: Server type (static or dynamic).
servers GetLinkmonitorServer[]: 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.
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.
updateCascadeInterface string: Enable/disable update cascade interface.
updatePolicyRoute string: Enable/disable updating the policy route.
updateStaticRoute string: Enable/disable updating the static route.
vdomparam string

addr_mode str: Address mode (IPv4 or IPv6).
class_id int: Traffic class ID.
diffservcode str: Differentiated services code point (DSCP) in the IP header of the probe packet.
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.
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.
id str: The provider-assigned unique ID for this managed resource.
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[GetLinkmonitorRoute]: Subnet to monitor. The structure of route block is documented below.
security_mode str: Twamp controller security mode.
server_config str: Mode of server configuration.
server_lists Sequence[GetLinkmonitorServerList]: Servers for link-monitor to monitor. The structure of server_list block is documented below.
server_type str: Server type (static or dynamic).
servers Sequence[GetLinkmonitorServer]: 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.
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.
update_cascade_interface str: Enable/disable update cascade interface.
update_policy_route str: Enable/disable updating the policy route.
update_static_route str: Enable/disable updating the static route.
vdomparam str

addrMode String: Address mode (IPv4 or IPv6).
classId Number: Traffic class ID.
diffservcode String: Differentiated services code point (DSCP) in the IP header of the probe packet.
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.
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.
id String: The provider-assigned unique ID for this managed resource.
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.
serverConfig String: Mode of server configuration.
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).
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.
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.
updateCascadeInterface String: Enable/disable update cascade interface.
updatePolicyRoute String: Enable/disable updating the policy route.
updateStaticRoute String: Enable/disable updating the static route.
vdomparam String

Supporting Types

GetLinkmonitorRoute

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).

GetLinkmonitorServer

Address string: Server address.

Address string: Server address.

address String: Server address.

address string: Server address.

address str: Server address.

address String: Server address.

GetLinkmonitorServerList

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).

Package Details

Repository: fortios pulumiverse/pulumi-fortios
License: Apache-2.0
Notes: This Pulumi package is based on the fortios Terraform Provider.

Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

pulumiverse/pulumi-fortios

fortios.system.getLinkmonitor

On this page

On this page

Using getLinkmonitor

getLinkmonitor Result

Supporting Types

GetLinkmonitorRoute

GetLinkmonitorServer

GetLinkmonitorServerList

Package Details

On this page

On this page