Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. F5bigip Provider
  3. API Docs
  4. ltm
  5. Monitor
f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.ltm.Monitor

Explore with Pulumi AI

f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.ltm.Monitor Configures a custom monitor for use by health checks.

For resources should be named with their full path. The full path is the combination of the partition + name of the resource. For example /Common/test-monitor.

Example Usage

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

const monitor = new f5bigip.ltm.Monitor("monitor", {
    name: "/Common/terraform_monitor",
    parent: "/Common/http",
    send: "GET /some/path\x0d\n",
    timeout: 999,
    interval: 998,
    destination: "1.2.3.4:1234",
});
const test_https_monitor = new f5bigip.ltm.Monitor("test-https-monitor", {
    name: "/Common/terraform_monitor",
    parent: "/Common/http",
    sslProfile: "/Common/serverssl",
    send: "GET /some/path\x0d\n",
    interval: 999,
    timeout: 1000,
});
const test_ftp_monitor = new f5bigip.ltm.Monitor("test-ftp-monitor", {
    name: "/Common/ftp-test",
    parent: "/Common/ftp",
    interval: 5,
    timeUntilUp: 0,
    timeout: 16,
    destination: "*:8008",
    filename: "somefile",
});
const test_postgresql_monitor = new f5bigip.ltm.Monitor("test-postgresql-monitor", {
    name: "/Common/test-postgresql-monitor",
    parent: "/Common/postgresql",
    send: "SELECT 'Test';",
    receive: "Test",
    interval: 5,
    timeout: 16,
    username: "abcd",
    password: "abcd1234",
});
Copy
import pulumi
import pulumi_f5bigip as f5bigip

monitor = f5bigip.ltm.Monitor("monitor",
    name="/Common/terraform_monitor",
    parent="/Common/http",
    send="GET /some/path\x0d\n",
    timeout=999,
    interval=998,
    destination="1.2.3.4:1234")
test_https_monitor = f5bigip.ltm.Monitor("test-https-monitor",
    name="/Common/terraform_monitor",
    parent="/Common/http",
    ssl_profile="/Common/serverssl",
    send="GET /some/path\x0d\n",
    interval=999,
    timeout=1000)
test_ftp_monitor = f5bigip.ltm.Monitor("test-ftp-monitor",
    name="/Common/ftp-test",
    parent="/Common/ftp",
    interval=5,
    time_until_up=0,
    timeout=16,
    destination="*:8008",
    filename="somefile")
test_postgresql_monitor = f5bigip.ltm.Monitor("test-postgresql-monitor",
    name="/Common/test-postgresql-monitor",
    parent="/Common/postgresql",
    send="SELECT 'Test';",
    receive="Test",
    interval=5,
    timeout=16,
    username="abcd",
    password="abcd1234")
Copy
package main

import (
	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/ltm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ltm.NewMonitor(ctx, "monitor", &ltm.MonitorArgs{
			Name:        pulumi.String("/Common/terraform_monitor"),
			Parent:      pulumi.String("/Common/http"),
			Send:        pulumi.String("GET /some/path
\n"),
			Timeout:     pulumi.Int(999),
			Interval:    pulumi.Int(998),
			Destination: pulumi.String("1.2.3.4:1234"),
		})
		if err != nil {
			return err
		}
		_, err = ltm.NewMonitor(ctx, "test-https-monitor", &ltm.MonitorArgs{
			Name:       pulumi.String("/Common/terraform_monitor"),
			Parent:     pulumi.String("/Common/http"),
			SslProfile: pulumi.String("/Common/serverssl"),
			Send:       pulumi.String("GET /some/path
\n"),
			Interval:   pulumi.Int(999),
			Timeout:    pulumi.Int(1000),
		})
		if err != nil {
			return err
		}
		_, err = ltm.NewMonitor(ctx, "test-ftp-monitor", &ltm.MonitorArgs{
			Name:        pulumi.String("/Common/ftp-test"),
			Parent:      pulumi.String("/Common/ftp"),
			Interval:    pulumi.Int(5),
			TimeUntilUp: pulumi.Int(0),
			Timeout:     pulumi.Int(16),
			Destination: pulumi.String("*:8008"),
			Filename:    pulumi.String("somefile"),
		})
		if err != nil {
			return err
		}
		_, err = ltm.NewMonitor(ctx, "test-postgresql-monitor", &ltm.MonitorArgs{
			Name:     pulumi.String("/Common/test-postgresql-monitor"),
			Parent:   pulumi.String("/Common/postgresql"),
			Send:     pulumi.String("SELECT 'Test';"),
			Receive:  pulumi.String("Test"),
			Interval: pulumi.Int(5),
			Timeout:  pulumi.Int(16),
			Username: pulumi.String("abcd"),
			Password: pulumi.String("abcd1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

return await Deployment.RunAsync(() => 
{
    var monitor = new F5BigIP.Ltm.Monitor("monitor", new()
    {
        Name = "/Common/terraform_monitor",
        Parent = "/Common/http",
        Send = @"GET /some/path
",
        Timeout = 999,
        Interval = 998,
        Destination = "1.2.3.4:1234",
    });

    var test_https_monitor = new F5BigIP.Ltm.Monitor("test-https-monitor", new()
    {
        Name = "/Common/terraform_monitor",
        Parent = "/Common/http",
        SslProfile = "/Common/serverssl",
        Send = @"GET /some/path
",
        Interval = 999,
        Timeout = 1000,
    });

    var test_ftp_monitor = new F5BigIP.Ltm.Monitor("test-ftp-monitor", new()
    {
        Name = "/Common/ftp-test",
        Parent = "/Common/ftp",
        Interval = 5,
        TimeUntilUp = 0,
        Timeout = 16,
        Destination = "*:8008",
        Filename = "somefile",
    });

    var test_postgresql_monitor = new F5BigIP.Ltm.Monitor("test-postgresql-monitor", new()
    {
        Name = "/Common/test-postgresql-monitor",
        Parent = "/Common/postgresql",
        Send = "SELECT 'Test';",
        Receive = "Test",
        Interval = 5,
        Timeout = 16,
        Username = "abcd",
        Password = "abcd1234",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.ltm.Monitor;
import com.pulumi.f5bigip.ltm.MonitorArgs;
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 monitor = new Monitor("monitor", MonitorArgs.builder()
            .name("/Common/terraform_monitor")
            .parent("/Common/http")
            .send("""
GET /some/path
            """)
            .timeout("999")
            .interval("998")
            .destination("1.2.3.4:1234")
            .build());

        var test_https_monitor = new Monitor("test-https-monitor", MonitorArgs.builder()
            .name("/Common/terraform_monitor")
            .parent("/Common/http")
            .sslProfile("/Common/serverssl")
            .send("""
GET /some/path
            """)
            .interval("999")
            .timeout("1000")
            .build());

        var test_ftp_monitor = new Monitor("test-ftp-monitor", MonitorArgs.builder()
            .name("/Common/ftp-test")
            .parent("/Common/ftp")
            .interval(5)
            .timeUntilUp(0)
            .timeout(16)
            .destination("*:8008")
            .filename("somefile")
            .build());

        var test_postgresql_monitor = new Monitor("test-postgresql-monitor", MonitorArgs.builder()
            .name("/Common/test-postgresql-monitor")
            .parent("/Common/postgresql")
            .send("SELECT 'Test';")
            .receive("Test")
            .interval(5)
            .timeout(16)
            .username("abcd")
            .password("abcd1234")
            .build());

    }
}
Copy
resources:
  monitor:
    type: f5bigip:ltm:Monitor
    properties:
      name: /Common/terraform_monitor
      parent: /Common/http
      send: "GET /some/path\r\n"
      timeout: '999'
      interval: '998'
      destination: 1.2.3.4:1234
  test-https-monitor:
    type: f5bigip:ltm:Monitor
    properties:
      name: /Common/terraform_monitor
      parent: /Common/http
      sslProfile: /Common/serverssl
      send: "GET /some/path\r\n"
      interval: '999'
      timeout: '1000'
  test-ftp-monitor:
    type: f5bigip:ltm:Monitor
    properties:
      name: /Common/ftp-test
      parent: /Common/ftp
      interval: 5
      timeUntilUp: 0
      timeout: 16
      destination: '*:8008'
      filename: somefile
  test-postgresql-monitor:
    type: f5bigip:ltm:Monitor
    properties:
      name: /Common/test-postgresql-monitor
      parent: /Common/postgresql
      send: SELECT 'Test';
      receive: Test
      interval: 5
      timeout: 16
      username: abcd
      password: abcd1234
Copy

Create Monitor Resource

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

Constructor syntax

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

@overload
def Monitor(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            parent: Optional[str] = None,
            mode: Optional[str] = None,
            username: Optional[str] = None,
            adaptive: Optional[str] = None,
            custom_parent: Optional[str] = None,
            database: Optional[str] = None,
            destination: Optional[str] = None,
            filename: Optional[str] = None,
            filter: Optional[str] = None,
            interval: Optional[int] = None,
            ip_dscp: Optional[int] = None,
            mandatory_attributes: Optional[str] = None,
            manual_resume: Optional[str] = None,
            compatibility: Optional[str] = None,
            chase_referrals: Optional[str] = None,
            ssl_profile: Optional[str] = None,
            password: Optional[str] = None,
            receive: Optional[str] = None,
            receive_disable: Optional[str] = None,
            reverse: Optional[str] = None,
            security: Optional[str] = None,
            send: Optional[str] = None,
            adaptive_limit: Optional[int] = None,
            time_until_up: Optional[int] = None,
            timeout: Optional[int] = None,
            transparent: Optional[str] = None,
            up_interval: Optional[int] = None,
            base: Optional[str] = None)
func NewMonitor(ctx *Context, name string, args MonitorArgs, opts ...ResourceOption) (*Monitor, error)
public Monitor(string name, MonitorArgs args, CustomResourceOptions? opts = null)
public Monitor(String name, MonitorArgs args)
public Monitor(String name, MonitorArgs args, CustomResourceOptions options)

type: f5bigip:ltm:Monitor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MonitorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MonitorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MonitorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MonitorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MonitorArgs
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 monitorResource = new F5BigIP.Ltm.Monitor("monitorResource", new()
{
    Name = "string",
    Parent = "string",
    Mode = "string",
    Username = "string",
    Adaptive = "string",
    CustomParent = "string",
    Database = "string",
    Destination = "string",
    Filename = "string",
    Filter = "string",
    Interval = 0,
    IpDscp = 0,
    MandatoryAttributes = "string",
    ManualResume = "string",
    Compatibility = "string",
    ChaseReferrals = "string",
    SslProfile = "string",
    Password = "string",
    Receive = "string",
    ReceiveDisable = "string",
    Reverse = "string",
    Security = "string",
    Send = "string",
    AdaptiveLimit = 0,
    TimeUntilUp = 0,
    Timeout = 0,
    Transparent = "string",
    UpInterval = 0,
    Base = "string",
});
Copy
example, err := ltm.NewMonitor(ctx, "monitorResource", &ltm.MonitorArgs{
	Name:                pulumi.String("string"),
	Parent:              pulumi.String("string"),
	Mode:                pulumi.String("string"),
	Username:            pulumi.String("string"),
	Adaptive:            pulumi.String("string"),
	CustomParent:        pulumi.String("string"),
	Database:            pulumi.String("string"),
	Destination:         pulumi.String("string"),
	Filename:            pulumi.String("string"),
	Filter:              pulumi.String("string"),
	Interval:            pulumi.Int(0),
	IpDscp:              pulumi.Int(0),
	MandatoryAttributes: pulumi.String("string"),
	ManualResume:        pulumi.String("string"),
	Compatibility:       pulumi.String("string"),
	ChaseReferrals:      pulumi.String("string"),
	SslProfile:          pulumi.String("string"),
	Password:            pulumi.String("string"),
	Receive:             pulumi.String("string"),
	ReceiveDisable:      pulumi.String("string"),
	Reverse:             pulumi.String("string"),
	Security:            pulumi.String("string"),
	Send:                pulumi.String("string"),
	AdaptiveLimit:       pulumi.Int(0),
	TimeUntilUp:         pulumi.Int(0),
	Timeout:             pulumi.Int(0),
	Transparent:         pulumi.String("string"),
	UpInterval:          pulumi.Int(0),
	Base:                pulumi.String("string"),
})
Copy
var monitorResource = new Monitor("monitorResource", MonitorArgs.builder()
    .name("string")
    .parent("string")
    .mode("string")
    .username("string")
    .adaptive("string")
    .customParent("string")
    .database("string")
    .destination("string")
    .filename("string")
    .filter("string")
    .interval(0)
    .ipDscp(0)
    .mandatoryAttributes("string")
    .manualResume("string")
    .compatibility("string")
    .chaseReferrals("string")
    .sslProfile("string")
    .password("string")
    .receive("string")
    .receiveDisable("string")
    .reverse("string")
    .security("string")
    .send("string")
    .adaptiveLimit(0)
    .timeUntilUp(0)
    .timeout(0)
    .transparent("string")
    .upInterval(0)
    .base("string")
    .build());
Copy
monitor_resource = f5bigip.ltm.Monitor("monitorResource",
    name="string",
    parent="string",
    mode="string",
    username="string",
    adaptive="string",
    custom_parent="string",
    database="string",
    destination="string",
    filename="string",
    filter="string",
    interval=0,
    ip_dscp=0,
    mandatory_attributes="string",
    manual_resume="string",
    compatibility="string",
    chase_referrals="string",
    ssl_profile="string",
    password="string",
    receive="string",
    receive_disable="string",
    reverse="string",
    security="string",
    send="string",
    adaptive_limit=0,
    time_until_up=0,
    timeout=0,
    transparent="string",
    up_interval=0,
    base="string")
Copy
const monitorResource = new f5bigip.ltm.Monitor("monitorResource", {
    name: "string",
    parent: "string",
    mode: "string",
    username: "string",
    adaptive: "string",
    customParent: "string",
    database: "string",
    destination: "string",
    filename: "string",
    filter: "string",
    interval: 0,
    ipDscp: 0,
    mandatoryAttributes: "string",
    manualResume: "string",
    compatibility: "string",
    chaseReferrals: "string",
    sslProfile: "string",
    password: "string",
    receive: "string",
    receiveDisable: "string",
    reverse: "string",
    security: "string",
    send: "string",
    adaptiveLimit: 0,
    timeUntilUp: 0,
    timeout: 0,
    transparent: "string",
    upInterval: 0,
    base: "string",
});
Copy
type: f5bigip:ltm:Monitor
properties:
    adaptive: string
    adaptiveLimit: 0
    base: string
    chaseReferrals: string
    compatibility: string
    customParent: string
    database: string
    destination: string
    filename: string
    filter: string
    interval: 0
    ipDscp: 0
    mandatoryAttributes: string
    manualResume: string
    mode: string
    name: string
    parent: string
    password: string
    receive: string
    receiveDisable: string
    reverse: string
    security: string
    send: string
    sslProfile: string
    timeUntilUp: 0
    timeout: 0
    transparent: string
    upInterval: 0
    username: string
Copy

Monitor 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 Monitor resource accepts the following input properties:

Name
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
Parent
This property is required.
Changes to this property will trigger replacement.
string
Parent monitor for the system to use for setting initial values for the new monitor.
Adaptive string
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
AdaptiveLimit int
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
Base string
Specifies the location in the LDAP tree from which the monitor starts the health check
ChaseReferrals string
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
Compatibility string
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
CustomParent string
Custom parent monitor for the system to use for setting initial values for the new monitor.
Database string
Specifies the database in which the user is created
Destination string
Specify an alias address for monitoring
Filename string
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
Filter string
Specifies an LDAP key for which the monitor searches
Interval int
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
IpDscp int
Displays the differentiated services code point (DSCP).The default is 0 (zero).
MandatoryAttributes string
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
ManualResume string
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
Mode string
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
Password string
Specifies the password if the monitored target requires authentication
Receive string
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
ReceiveDisable string
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
Reverse string
Instructs the system to mark the target resource down when the test is successful.
Security string
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
Send string
Specifies the text string that the monitor sends to the target object.
SslProfile string
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
TimeUntilUp int
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
Timeout int
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
Transparent string
Specifies whether the monitor operates in transparent mode.
UpInterval int
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
Username string
Specifies the user name if the monitored target requires authentication
Name
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
Parent
This property is required.
Changes to this property will trigger replacement.
string
Parent monitor for the system to use for setting initial values for the new monitor.
Adaptive string
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
AdaptiveLimit int
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
Base string
Specifies the location in the LDAP tree from which the monitor starts the health check
ChaseReferrals string
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
Compatibility string
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
CustomParent string
Custom parent monitor for the system to use for setting initial values for the new monitor.
Database string
Specifies the database in which the user is created
Destination string
Specify an alias address for monitoring
Filename string
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
Filter string
Specifies an LDAP key for which the monitor searches
Interval int
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
IpDscp int
Displays the differentiated services code point (DSCP).The default is 0 (zero).
MandatoryAttributes string
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
ManualResume string
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
Mode string
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
Password string
Specifies the password if the monitored target requires authentication
Receive string
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
ReceiveDisable string
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
Reverse string
Instructs the system to mark the target resource down when the test is successful.
Security string
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
Send string
Specifies the text string that the monitor sends to the target object.
SslProfile string
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
TimeUntilUp int
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
Timeout int
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
Transparent string
Specifies whether the monitor operates in transparent mode.
UpInterval int
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
Username string
Specifies the user name if the monitored target requires authentication
name
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
parent
This property is required.
Changes to this property will trigger replacement.
String
Parent monitor for the system to use for setting initial values for the new monitor.
adaptive String
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
adaptiveLimit Integer
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
base String
Specifies the location in the LDAP tree from which the monitor starts the health check
chaseReferrals String
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
compatibility String
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
customParent String
Custom parent monitor for the system to use for setting initial values for the new monitor.
database String
Specifies the database in which the user is created
destination String
Specify an alias address for monitoring
filename String
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
filter String
Specifies an LDAP key for which the monitor searches
interval Integer
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
ipDscp Integer
Displays the differentiated services code point (DSCP).The default is 0 (zero).
mandatoryAttributes String
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
manualResume String
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
mode String
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
password String
Specifies the password if the monitored target requires authentication
receive String
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
receiveDisable String
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
reverse String
Instructs the system to mark the target resource down when the test is successful.
security String
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
send String
Specifies the text string that the monitor sends to the target object.
sslProfile String
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
timeUntilUp Integer
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
timeout Integer
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
transparent String
Specifies whether the monitor operates in transparent mode.
upInterval Integer
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
username String
Specifies the user name if the monitored target requires authentication
name
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
parent
This property is required.
Changes to this property will trigger replacement.
string
Parent monitor for the system to use for setting initial values for the new monitor.
adaptive string
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
adaptiveLimit number
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
base string
Specifies the location in the LDAP tree from which the monitor starts the health check
chaseReferrals string
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
compatibility string
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
customParent string
Custom parent monitor for the system to use for setting initial values for the new monitor.
database string
Specifies the database in which the user is created
destination string
Specify an alias address for monitoring
filename string
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
filter string
Specifies an LDAP key for which the monitor searches
interval number
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
ipDscp number
Displays the differentiated services code point (DSCP).The default is 0 (zero).
mandatoryAttributes string
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
manualResume string
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
mode string
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
password string
Specifies the password if the monitored target requires authentication
receive string
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
receiveDisable string
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
reverse string
Instructs the system to mark the target resource down when the test is successful.
security string
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
send string
Specifies the text string that the monitor sends to the target object.
sslProfile string
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
timeUntilUp number
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
timeout number
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
transparent string
Specifies whether the monitor operates in transparent mode.
upInterval number
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
username string
Specifies the user name if the monitored target requires authentication
name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
parent
This property is required.
Changes to this property will trigger replacement.
str
Parent monitor for the system to use for setting initial values for the new monitor.
adaptive str
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
adaptive_limit int
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
base str
Specifies the location in the LDAP tree from which the monitor starts the health check
chase_referrals str
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
compatibility str
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
custom_parent str
Custom parent monitor for the system to use for setting initial values for the new monitor.
database str
Specifies the database in which the user is created
destination str
Specify an alias address for monitoring
filename str
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
filter str
Specifies an LDAP key for which the monitor searches
interval int
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
ip_dscp int
Displays the differentiated services code point (DSCP).The default is 0 (zero).
mandatory_attributes str
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
manual_resume str
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
mode str
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
password str
Specifies the password if the monitored target requires authentication
receive str
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
receive_disable str
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
reverse str
Instructs the system to mark the target resource down when the test is successful.
security str
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
send str
Specifies the text string that the monitor sends to the target object.
ssl_profile str
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
time_until_up int
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
timeout int
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
transparent str
Specifies whether the monitor operates in transparent mode.
up_interval int
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
username str
Specifies the user name if the monitored target requires authentication
name
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
parent
This property is required.
Changes to this property will trigger replacement.
String
Parent monitor for the system to use for setting initial values for the new monitor.
adaptive String
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
adaptiveLimit Number
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
base String
Specifies the location in the LDAP tree from which the monitor starts the health check
chaseReferrals String
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
compatibility String
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
customParent String
Custom parent monitor for the system to use for setting initial values for the new monitor.
database String
Specifies the database in which the user is created
destination String
Specify an alias address for monitoring
filename String
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
filter String
Specifies an LDAP key for which the monitor searches
interval Number
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
ipDscp Number
Displays the differentiated services code point (DSCP).The default is 0 (zero).
mandatoryAttributes String
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
manualResume String
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
mode String
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
password String
Specifies the password if the monitored target requires authentication
receive String
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
receiveDisable String
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
reverse String
Instructs the system to mark the target resource down when the test is successful.
security String
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
send String
Specifies the text string that the monitor sends to the target object.
sslProfile String
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
timeUntilUp Number
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
timeout Number
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
transparent String
Specifies whether the monitor operates in transparent mode.
upInterval Number
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
username String
Specifies the user name if the monitored target requires authentication

Outputs

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

Get an existing Monitor 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?: MonitorState, opts?: CustomResourceOptions): Monitor
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adaptive: Optional[str] = None,
        adaptive_limit: Optional[int] = None,
        base: Optional[str] = None,
        chase_referrals: Optional[str] = None,
        compatibility: Optional[str] = None,
        custom_parent: Optional[str] = None,
        database: Optional[str] = None,
        destination: Optional[str] = None,
        filename: Optional[str] = None,
        filter: Optional[str] = None,
        interval: Optional[int] = None,
        ip_dscp: Optional[int] = None,
        mandatory_attributes: Optional[str] = None,
        manual_resume: Optional[str] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None,
        password: Optional[str] = None,
        receive: Optional[str] = None,
        receive_disable: Optional[str] = None,
        reverse: Optional[str] = None,
        security: Optional[str] = None,
        send: Optional[str] = None,
        ssl_profile: Optional[str] = None,
        time_until_up: Optional[int] = None,
        timeout: Optional[int] = None,
        transparent: Optional[str] = None,
        up_interval: Optional[int] = None,
        username: Optional[str] = None) -> Monitor
func GetMonitor(ctx *Context, name string, id IDInput, state *MonitorState, opts ...ResourceOption) (*Monitor, error)
public static Monitor Get(string name, Input<string> id, MonitorState? state, CustomResourceOptions? opts = null)
public static Monitor get(String name, Output<String> id, MonitorState state, CustomResourceOptions options)
resources:  _:    type: f5bigip:ltm:Monitor    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Adaptive string
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
AdaptiveLimit int
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
Base string
Specifies the location in the LDAP tree from which the monitor starts the health check
ChaseReferrals string
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
Compatibility string
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
CustomParent string
Custom parent monitor for the system to use for setting initial values for the new monitor.
Database string
Specifies the database in which the user is created
Destination string
Specify an alias address for monitoring
Filename string
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
Filter string
Specifies an LDAP key for which the monitor searches
Interval int
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
IpDscp int
Displays the differentiated services code point (DSCP).The default is 0 (zero).
MandatoryAttributes string
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
ManualResume string
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
Mode string
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
Name Changes to this property will trigger replacement. string
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
Parent Changes to this property will trigger replacement. string
Parent monitor for the system to use for setting initial values for the new monitor.
Password string
Specifies the password if the monitored target requires authentication
Receive string
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
ReceiveDisable string
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
Reverse string
Instructs the system to mark the target resource down when the test is successful.
Security string
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
Send string
Specifies the text string that the monitor sends to the target object.
SslProfile string
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
TimeUntilUp int
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
Timeout int
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
Transparent string
Specifies whether the monitor operates in transparent mode.
UpInterval int
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
Username string
Specifies the user name if the monitored target requires authentication
Adaptive string
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
AdaptiveLimit int
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
Base string
Specifies the location in the LDAP tree from which the monitor starts the health check
ChaseReferrals string
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
Compatibility string
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
CustomParent string
Custom parent monitor for the system to use for setting initial values for the new monitor.
Database string
Specifies the database in which the user is created
Destination string
Specify an alias address for monitoring
Filename string
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
Filter string
Specifies an LDAP key for which the monitor searches
Interval int
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
IpDscp int
Displays the differentiated services code point (DSCP).The default is 0 (zero).
MandatoryAttributes string
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
ManualResume string
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
Mode string
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
Name Changes to this property will trigger replacement. string
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
Parent Changes to this property will trigger replacement. string
Parent monitor for the system to use for setting initial values for the new monitor.
Password string
Specifies the password if the monitored target requires authentication
Receive string
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
ReceiveDisable string
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
Reverse string
Instructs the system to mark the target resource down when the test is successful.
Security string
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
Send string
Specifies the text string that the monitor sends to the target object.
SslProfile string
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
TimeUntilUp int
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
Timeout int
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
Transparent string
Specifies whether the monitor operates in transparent mode.
UpInterval int
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
Username string
Specifies the user name if the monitored target requires authentication
adaptive String
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
adaptiveLimit Integer
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
base String
Specifies the location in the LDAP tree from which the monitor starts the health check
chaseReferrals String
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
compatibility String
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
customParent String
Custom parent monitor for the system to use for setting initial values for the new monitor.
database String
Specifies the database in which the user is created
destination String
Specify an alias address for monitoring
filename String
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
filter String
Specifies an LDAP key for which the monitor searches
interval Integer
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
ipDscp Integer
Displays the differentiated services code point (DSCP).The default is 0 (zero).
mandatoryAttributes String
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
manualResume String
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
mode String
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
name Changes to this property will trigger replacement. String
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
parent Changes to this property will trigger replacement. String
Parent monitor for the system to use for setting initial values for the new monitor.
password String
Specifies the password if the monitored target requires authentication
receive String
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
receiveDisable String
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
reverse String
Instructs the system to mark the target resource down when the test is successful.
security String
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
send String
Specifies the text string that the monitor sends to the target object.
sslProfile String
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
timeUntilUp Integer
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
timeout Integer
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
transparent String
Specifies whether the monitor operates in transparent mode.
upInterval Integer
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
username String
Specifies the user name if the monitored target requires authentication
adaptive string
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
adaptiveLimit number
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
base string
Specifies the location in the LDAP tree from which the monitor starts the health check
chaseReferrals string
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
compatibility string
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
customParent string
Custom parent monitor for the system to use for setting initial values for the new monitor.
database string
Specifies the database in which the user is created
destination string
Specify an alias address for monitoring
filename string
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
filter string
Specifies an LDAP key for which the monitor searches
interval number
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
ipDscp number
Displays the differentiated services code point (DSCP).The default is 0 (zero).
mandatoryAttributes string
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
manualResume string
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
mode string
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
name Changes to this property will trigger replacement. string
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
parent Changes to this property will trigger replacement. string
Parent monitor for the system to use for setting initial values for the new monitor.
password string
Specifies the password if the monitored target requires authentication
receive string
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
receiveDisable string
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
reverse string
Instructs the system to mark the target resource down when the test is successful.
security string
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
send string
Specifies the text string that the monitor sends to the target object.
sslProfile string
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
timeUntilUp number
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
timeout number
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
transparent string
Specifies whether the monitor operates in transparent mode.
upInterval number
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
username string
Specifies the user name if the monitored target requires authentication
adaptive str
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
adaptive_limit int
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
base str
Specifies the location in the LDAP tree from which the monitor starts the health check
chase_referrals str
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
compatibility str
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
custom_parent str
Custom parent monitor for the system to use for setting initial values for the new monitor.
database str
Specifies the database in which the user is created
destination str
Specify an alias address for monitoring
filename str
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
filter str
Specifies an LDAP key for which the monitor searches
interval int
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
ip_dscp int
Displays the differentiated services code point (DSCP).The default is 0 (zero).
mandatory_attributes str
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
manual_resume str
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
mode str
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
name Changes to this property will trigger replacement. str
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
parent Changes to this property will trigger replacement. str
Parent monitor for the system to use for setting initial values for the new monitor.
password str
Specifies the password if the monitored target requires authentication
receive str
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
receive_disable str
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
reverse str
Instructs the system to mark the target resource down when the test is successful.
security str
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
send str
Specifies the text string that the monitor sends to the target object.
ssl_profile str
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
time_until_up int
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
timeout int
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
transparent str
Specifies whether the monitor operates in transparent mode.
up_interval int
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
username str
Specifies the user name if the monitored target requires authentication
adaptive String
Specifies whether adaptive response time monitoring is enabled for this monitor. The default is disabled.
adaptiveLimit Number
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of Allowed Divergence.
base String
Specifies the location in the LDAP tree from which the monitor starts the health check
chaseReferrals String
Specifies whether the system will query the LDAP servers pointed to by any referrals in the query results.
compatibility String
Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. Accepts 'enabled' or 'disabled' values, the default value is 'enabled'.
customParent String
Custom parent monitor for the system to use for setting initial values for the new monitor.
database String
Specifies the database in which the user is created
destination String
Specify an alias address for monitoring
filename String
Specifies the full path and file name of the file that the system attempts to download. The health check is successful if the system can download the file.
filter String
Specifies an LDAP key for which the monitor searches
interval Number
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown,value of interval should be always less than timeout. Default is 5.
ipDscp Number
Displays the differentiated services code point (DSCP).The default is 0 (zero).
mandatoryAttributes String
Specifies whether the target must include attributes in its response to be considered up. The options are no (Specifies that the system performs only a one-level search (based on the Filter setting), and does not require that the target returns any attributes.) and yes (Specifies that the system performs a sub-tree search, and if the target returns no attributes, the target is considered down.)
manualResume String
Specifies whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
mode String
Specifies the data transfer process (DTP) mode. The default value is passive. The options are passive (Specifies that the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server then initiates and establishes the data connection.) and active (Specifies that the monitor initiates and establishes the data connection with the FTP server.).
name Changes to this property will trigger replacement. String
Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the partition + monitor name,For ex:/Common/test-ltm-monitor.
parent Changes to this property will trigger replacement. String
Parent monitor for the system to use for setting initial values for the new monitor.
password String
Specifies the password if the monitored target requires authentication
receive String
Specifies the regular expression representing the text string that the monitor looks for in the returned resource.
receiveDisable String
The system marks the node or pool member disabled when its response matches Receive Disable String but not Receive String.
reverse String
Instructs the system to mark the target resource down when the test is successful.
security String
Specifies the secure communications protocol that the monitor uses to communicate with the target. The options are none (Specifies that the system does not use a security protocol for communications with the target.), ssl (Specifies that the system uses the SSL protocol for communications with the target.), and tls (Specifies that the system uses the TLS protocol for communications with the target.)
send String
Specifies the text string that the monitor sends to the target object.
sslProfile String
Specifies the ssl profile for the monitor. It only makes sense when the parent is /Common/https
timeUntilUp Number
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to up.
timeout Number
Specifies the number of seconds the target has in which to respond to the monitor request. The default is 16 seconds
transparent String
Specifies whether the monitor operates in transparent mode.
upInterval Number
Specifies the interval for the system to use to perform the health check when a resource is up. The default is 0(Disabled)
username String
Specifies the user name if the monitored target requires authentication

Import

ing

An existing monitor can be imported into this resource by supplying monitor Name in full path as id. An example is below:

$ terraform import bigip_ltm_monitor.monitor /Common/terraform_monitor
Copy

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

Package Details

Repository
f5 BIG-IP pulumi/pulumi-f5bigip
License
Apache-2.0
Notes
This Pulumi package is based on the bigip Terraform Provider.
f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-f5bigip