1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. ltm
  5. getMonitor
f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi

f5bigip.ltm.getMonitor

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi

    Use this data source (f5bigip.ltm.Monitor) to get the ltm monitor details available on BIG-IP

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const monitor-TC1 = f5bigip.ltm.getMonitor({
        name: "test-monitor",
        partition: "Common",
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    monitor__tc1 = f5bigip.ltm.get_monitor(name="test-monitor",
        partition="Common")
    
    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.LookupMonitor(ctx, &ltm.LookupMonitorArgs{
    			Name:      "test-monitor",
    			Partition: "Common",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var monitor_TC1 = F5BigIP.Ltm.GetMonitor.Invoke(new()
        {
            Name = "test-monitor",
            Partition = "Common",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.ltm.LtmFunctions;
    import com.pulumi.f5bigip.ltm.inputs.GetMonitorArgs;
    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) {
            final var monitor-TC1 = LtmFunctions.getMonitor(GetMonitorArgs.builder()
                .name("test-monitor")
                .partition("Common")
                .build());
    
        }
    }
    
    variables:
      monitor-TC1:
        fn::invoke:
          Function: f5bigip:ltm:getMonitor
          Arguments:
            name: test-monitor
            partition: Common
    

    Using getMonitor

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

    function getMonitor(args: GetMonitorArgs, opts?: InvokeOptions): Promise<GetMonitorResult>
    function getMonitorOutput(args: GetMonitorOutputArgs, opts?: InvokeOptions): Output<GetMonitorResult>
    def get_monitor(name: Optional[str] = None,
                    partition: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetMonitorResult
    def get_monitor_output(name: Optional[pulumi.Input[str]] = None,
                    partition: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetMonitorResult]
    func LookupMonitor(ctx *Context, args *LookupMonitorArgs, opts ...InvokeOption) (*LookupMonitorResult, error)
    func LookupMonitorOutput(ctx *Context, args *LookupMonitorOutputArgs, opts ...InvokeOption) LookupMonitorResultOutput

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

    public static class GetMonitor 
    {
        public static Task<GetMonitorResult> InvokeAsync(GetMonitorArgs args, InvokeOptions? opts = null)
        public static Output<GetMonitorResult> Invoke(GetMonitorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: f5bigip:ltm/getMonitor:getMonitor
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the ltm monitor
    Partition string
    partition of the ltm monitor
    Name string
    Name of the ltm monitor
    Partition string
    partition of the ltm monitor
    name String
    Name of the ltm monitor
    partition String
    partition of the ltm monitor
    name string
    Name of the ltm monitor
    partition string
    partition of the ltm monitor
    name str
    Name of the ltm monitor
    partition str
    partition of the ltm monitor
    name String
    Name of the ltm monitor
    partition String
    partition of the ltm monitor

    getMonitor Result

    The following output properties are available:

    Adaptive string
    Displays whether adaptive response time monitoring is enabled for this monitor.
    AdaptiveLimit int
    Displays whether adaptive response time monitoring is enabled for this monitor.
    Database string
    DefaultsFrom string
    Destination string
    id will be full path name of ltm monitor.
    Filename string
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    IpDscp int
    Displays the differentiated services code point (DSCP). DSCP is a 6-bit value in the Differentiated Services (DS) field of the IP header.
    ManualResume string
    Displays whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
    Mode string
    Name string
    Partition string
    ReceiveDisable string
    Reverse string
    Instructs the system to mark the target resource down when the test is successful.
    TimeUntilUp int
    Timeout int
    Transparent string
    Displays whether the monitor operates in transparent mode.
    Username string
    Adaptive string
    Displays whether adaptive response time monitoring is enabled for this monitor.
    AdaptiveLimit int
    Displays whether adaptive response time monitoring is enabled for this monitor.
    Database string
    DefaultsFrom string
    Destination string
    id will be full path name of ltm monitor.
    Filename string
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    IpDscp int
    Displays the differentiated services code point (DSCP). DSCP is a 6-bit value in the Differentiated Services (DS) field of the IP header.
    ManualResume string
    Displays whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
    Mode string
    Name string
    Partition string
    ReceiveDisable string
    Reverse string
    Instructs the system to mark the target resource down when the test is successful.
    TimeUntilUp int
    Timeout int
    Transparent string
    Displays whether the monitor operates in transparent mode.
    Username string
    adaptive String
    Displays whether adaptive response time monitoring is enabled for this monitor.
    adaptiveLimit Integer
    Displays whether adaptive response time monitoring is enabled for this monitor.
    database String
    defaultsFrom String
    destination String
    id will be full path name of ltm monitor.
    filename String
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    ipDscp Integer
    Displays the differentiated services code point (DSCP). DSCP is a 6-bit value in the Differentiated Services (DS) field of the IP header.
    manualResume String
    Displays whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
    mode String
    name String
    partition String
    receiveDisable String
    reverse String
    Instructs the system to mark the target resource down when the test is successful.
    timeUntilUp Integer
    timeout Integer
    transparent String
    Displays whether the monitor operates in transparent mode.
    username String
    adaptive string
    Displays whether adaptive response time monitoring is enabled for this monitor.
    adaptiveLimit number
    Displays whether adaptive response time monitoring is enabled for this monitor.
    database string
    defaultsFrom string
    destination string
    id will be full path name of ltm monitor.
    filename string
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    ipDscp number
    Displays the differentiated services code point (DSCP). DSCP is a 6-bit value in the Differentiated Services (DS) field of the IP header.
    manualResume string
    Displays whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
    mode string
    name string
    partition string
    receiveDisable string
    reverse string
    Instructs the system to mark the target resource down when the test is successful.
    timeUntilUp number
    timeout number
    transparent string
    Displays whether the monitor operates in transparent mode.
    username string
    adaptive str
    Displays whether adaptive response time monitoring is enabled for this monitor.
    adaptive_limit int
    Displays whether adaptive response time monitoring is enabled for this monitor.
    database str
    defaults_from str
    destination str
    id will be full path name of ltm monitor.
    filename str
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    ip_dscp int
    Displays the differentiated services code point (DSCP). DSCP is a 6-bit value in the Differentiated Services (DS) field of the IP header.
    manual_resume str
    Displays whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
    mode str
    name str
    partition str
    receive_disable str
    reverse str
    Instructs the system to mark the target resource down when the test is successful.
    time_until_up int
    timeout int
    transparent str
    Displays whether the monitor operates in transparent mode.
    username str
    adaptive String
    Displays whether adaptive response time monitoring is enabled for this monitor.
    adaptiveLimit Number
    Displays whether adaptive response time monitoring is enabled for this monitor.
    database String
    defaultsFrom String
    destination String
    id will be full path name of ltm monitor.
    filename String
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    ipDscp Number
    Displays the differentiated services code point (DSCP). DSCP is a 6-bit value in the Differentiated Services (DS) field of the IP header.
    manualResume String
    Displays whether the system automatically changes the status of a resource to Enabled at the next successful monitor check.
    mode String
    name String
    partition String
    receiveDisable String
    reverse String
    Instructs the system to mark the target resource down when the test is successful.
    timeUntilUp Number
    timeout Number
    transparent String
    Displays whether the monitor operates in transparent mode.
    username String

    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.17.0 published on Thursday, Mar 28, 2024 by Pulumi