1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. ltm
  5. Monitor
f5 BIG-IP v3.16.0 published on Monday, Feb 19, 2024 by Pulumi

f5bigip.ltm.Monitor

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.16.0 published on Monday, Feb 19, 2024 by Pulumi

    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

    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()
        {
            Destination = "1.2.3.4:1234",
            Interval = 998,
            Name = "/Common/terraform_monitor",
            Parent = "/Common/http",
            Send = @"GET /some/path
    
    ",
            Timeout = 999,
        });
    
        var test_https_monitor = new F5BigIP.Ltm.Monitor("test-https-monitor", new()
        {
            Interval = 999,
            Name = "/Common/terraform_monitor",
            Parent = "/Common/http",
            Send = @"GET /some/path
    
    ",
            SslProfile = "/Common/serverssl",
            Timeout = 1000,
        });
    
        var test_ftp_monitor = new F5BigIP.Ltm.Monitor("test-ftp-monitor", new()
        {
            Destination = "*:8008",
            Filename = "somefile",
            Interval = 5,
            Name = "/Common/ftp-test",
            Parent = "/Common/ftp",
            TimeUntilUp = 0,
            Timeout = 16,
        });
    
        var test_postgresql_monitor = new F5BigIP.Ltm.Monitor("test-postgresql-monitor", new()
        {
            Interval = 5,
            Name = "/Common/test-postgresql-monitor",
            Parent = "/Common/postgresql",
            Password = "abcd1234",
            Receive = "Test",
            Send = "SELECT 'Test';",
            Timeout = 16,
            Username = "abcd",
        });
    
    });
    
    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{
    			Destination: pulumi.String("1.2.3.4:1234"),
    			Interval:    pulumi.Int(998),
    			Name:        pulumi.String("/Common/terraform_monitor"),
    			Parent:      pulumi.String("/Common/http"),
    			Send:        pulumi.String("GET /some/path
    \n\n"),
    			Timeout:     pulumi.Int(999),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ltm.NewMonitor(ctx, "test-https-monitor", &ltm.MonitorArgs{
    			Interval:   pulumi.Int(999),
    			Name:       pulumi.String("/Common/terraform_monitor"),
    			Parent:     pulumi.String("/Common/http"),
    			Send:       pulumi.String("GET /some/path
    \n\n"),
    			SslProfile: pulumi.String("/Common/serverssl"),
    			Timeout:    pulumi.Int(1000),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ltm.NewMonitor(ctx, "test-ftp-monitor", &ltm.MonitorArgs{
    			Destination: pulumi.String("*:8008"),
    			Filename:    pulumi.String("somefile"),
    			Interval:    pulumi.Int(5),
    			Name:        pulumi.String("/Common/ftp-test"),
    			Parent:      pulumi.String("/Common/ftp"),
    			TimeUntilUp: pulumi.Int(0),
    			Timeout:     pulumi.Int(16),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ltm.NewMonitor(ctx, "test-postgresql-monitor", &ltm.MonitorArgs{
    			Interval: pulumi.Int(5),
    			Name:     pulumi.String("/Common/test-postgresql-monitor"),
    			Parent:   pulumi.String("/Common/postgresql"),
    			Password: pulumi.String("abcd1234"),
    			Receive:  pulumi.String("Test"),
    			Send:     pulumi.String("SELECT 'Test';"),
    			Timeout:  pulumi.Int(16),
    			Username: pulumi.String("abcd"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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()        
                .destination("1.2.3.4:1234")
                .interval("998")
                .name("/Common/terraform_monitor")
                .parent("/Common/http")
                .send("""
    GET /some/path
    
                """)
                .timeout("999")
                .build());
    
            var test_https_monitor = new Monitor("test-https-monitor", MonitorArgs.builder()        
                .interval("999")
                .name("/Common/terraform_monitor")
                .parent("/Common/http")
                .send("""
    GET /some/path
    
                """)
                .sslProfile("/Common/serverssl")
                .timeout("1000")
                .build());
    
            var test_ftp_monitor = new Monitor("test-ftp-monitor", MonitorArgs.builder()        
                .destination("*:8008")
                .filename("somefile")
                .interval(5)
                .name("/Common/ftp-test")
                .parent("/Common/ftp")
                .timeUntilUp(0)
                .timeout(16)
                .build());
    
            var test_postgresql_monitor = new Monitor("test-postgresql-monitor", MonitorArgs.builder()        
                .interval(5)
                .name("/Common/test-postgresql-monitor")
                .parent("/Common/postgresql")
                .password("abcd1234")
                .receive("Test")
                .send("SELECT 'Test';")
                .timeout(16)
                .username("abcd")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    monitor = f5bigip.ltm.Monitor("monitor",
        destination="1.2.3.4:1234",
        interval=998,
        name="/Common/terraform_monitor",
        parent="/Common/http",
        send="""GET /some/path
    
    """,
        timeout=999)
    test_https_monitor = f5bigip.ltm.Monitor("test-https-monitor",
        interval=999,
        name="/Common/terraform_monitor",
        parent="/Common/http",
        send="""GET /some/path
    
    """,
        ssl_profile="/Common/serverssl",
        timeout=1000)
    test_ftp_monitor = f5bigip.ltm.Monitor("test-ftp-monitor",
        destination="*:8008",
        filename="somefile",
        interval=5,
        name="/Common/ftp-test",
        parent="/Common/ftp",
        time_until_up=0,
        timeout=16)
    test_postgresql_monitor = f5bigip.ltm.Monitor("test-postgresql-monitor",
        interval=5,
        name="/Common/test-postgresql-monitor",
        parent="/Common/postgresql",
        password="abcd1234",
        receive="Test",
        send="SELECT 'Test';",
        timeout=16,
        username="abcd")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const monitor = new f5bigip.ltm.Monitor("monitor", {
        destination: "1.2.3.4:1234",
        interval: 998,
        name: "/Common/terraform_monitor",
        parent: "/Common/http",
        send: `GET /some/path
    
    `,
        timeout: 999,
    });
    const test_https_monitor = new f5bigip.ltm.Monitor("test-https-monitor", {
        interval: 999,
        name: "/Common/terraform_monitor",
        parent: "/Common/http",
        send: `GET /some/path
    
    `,
        sslProfile: "/Common/serverssl",
        timeout: 1000,
    });
    const test_ftp_monitor = new f5bigip.ltm.Monitor("test-ftp-monitor", {
        destination: "*:8008",
        filename: "somefile",
        interval: 5,
        name: "/Common/ftp-test",
        parent: "/Common/ftp",
        timeUntilUp: 0,
        timeout: 16,
    });
    const test_postgresql_monitor = new f5bigip.ltm.Monitor("test-postgresql-monitor", {
        interval: 5,
        name: "/Common/test-postgresql-monitor",
        parent: "/Common/postgresql",
        password: "abcd1234",
        receive: "Test",
        send: "SELECT 'Test';",
        timeout: 16,
        username: "abcd",
    });
    
    resources:
      monitor:
        type: f5bigip:ltm:Monitor
        properties:
          destination: 1.2.3.4:1234
          interval: '998'
          name: /Common/terraform_monitor
          parent: /Common/http
          send: "GET /some/path\r\n\n"
          timeout: '999'
      test-https-monitor:
        type: f5bigip:ltm:Monitor
        properties:
          interval: '999'
          name: /Common/terraform_monitor
          parent: /Common/http
          send: "GET /some/path\r\n\n"
          sslProfile: /Common/serverssl
          timeout: '1000'
      test-ftp-monitor:
        type: f5bigip:ltm:Monitor
        properties:
          destination: '*:8008'
          filename: somefile
          interval: 5
          name: /Common/ftp-test
          parent: /Common/ftp
          timeUntilUp: 0
          timeout: 16
      test-postgresql-monitor:
        type: f5bigip:ltm:Monitor
        properties:
          interval: 5
          name: /Common/test-postgresql-monitor
          parent: /Common/postgresql
          password: abcd1234
          receive: Test
          send: SELECT 'Test';
          timeout: 16
          username: abcd
    

    Create Monitor Resource

    new Monitor(name: string, args: MonitorArgs, opts?: CustomResourceOptions);
    @overload
    def Monitor(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                adaptive: Optional[str] = None,
                adaptive_limit: Optional[int] = None,
                compatibility: Optional[str] = None,
                custom_parent: Optional[str] = None,
                database: Optional[str] = None,
                destination: Optional[str] = None,
                filename: Optional[str] = None,
                interval: Optional[int] = None,
                ip_dscp: Optional[int] = 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,
                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)
    @overload
    def Monitor(resource_name: str,
                args: MonitorArgs,
                opts: Optional[ResourceOptions] = 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.
    
    
    name string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The Monitor resource accepts the following input properties:

    Name 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 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.
    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.
    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).
    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.
    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 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 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.
    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.
    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).
    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.
    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 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 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.
    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.
    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).
    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.
    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 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 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.
    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.
    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).
    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.
    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 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 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.
    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.
    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).
    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.
    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 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 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.
    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.
    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).
    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.
    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,
            compatibility: Optional[str] = None,
            custom_parent: Optional[str] = None,
            database: Optional[str] = None,
            destination: Optional[str] = None,
            filename: Optional[str] = None,
            interval: Optional[int] = None,
            ip_dscp: Optional[int] = 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,
            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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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.
    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.
    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).
    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 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 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.
    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.
    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.
    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).
    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 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 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.
    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.
    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.
    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).
    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 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 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.
    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.
    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.
    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).
    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 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 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.
    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.
    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.
    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).
    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 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 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.
    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.
    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.
    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).
    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 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 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.
    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

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.16.0 published on Monday, Feb 19, 2024 by Pulumi