f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi
f5bigip.ltm.getMonitor
Explore with Pulumi AI
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, <m.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)
public static Output<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
fn::invoke:
  function: f5bigip:ltm/getMonitor:getMonitor
  arguments:
    # arguments dictionaryThe following arguments are supported:
getMonitor Result
The following output properties are available:
- Adaptive string
 - 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.
 - Base string
 - Chase
Referrals string - Database string
 - Defaults
From string - Destination string
 - id will be full path name of ltm monitor.
 - Filename string
 - Filter 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.
 - 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.
 - Mandatory
Attributes string - Manual
Resume 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
 - Receive
Disable string - Reverse string
 - Instructs the system to mark the target resource down when the test is successful.
 - Security string
 - Time
Until intUp  - 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.
 - Adaptive
Limit int - Displays whether adaptive response time monitoring is enabled for this monitor.
 - Base string
 - Chase
Referrals string - Database string
 - Defaults
From string - Destination string
 - id will be full path name of ltm monitor.
 - Filename string
 - Filter 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.
 - 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.
 - Mandatory
Attributes string - Manual
Resume 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
 - Receive
Disable string - Reverse string
 - Instructs the system to mark the target resource down when the test is successful.
 - Security string
 - Time
Until intUp  - 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.
 - adaptive
Limit Integer - Displays whether adaptive response time monitoring is enabled for this monitor.
 - base String
 - chase
Referrals String - database String
 - defaults
From String - destination String
 - id will be full path name of ltm monitor.
 - filename String
 - filter 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.
 - ip
Dscp Integer - Displays the differentiated services code point (DSCP). DSCP is a 6-bit value in the Differentiated Services (DS) field of the IP header.
 - mandatory
Attributes String - manual
Resume 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
 - receive
Disable String - reverse String
 - Instructs the system to mark the target resource down when the test is successful.
 - security String
 - time
Until IntegerUp  - 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.
 - adaptive
Limit number - Displays whether adaptive response time monitoring is enabled for this monitor.
 - base string
 - chase
Referrals string - database string
 - defaults
From string - destination string
 - id will be full path name of ltm monitor.
 - filename string
 - filter 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.
 - ip
Dscp number - Displays the differentiated services code point (DSCP). DSCP is a 6-bit value in the Differentiated Services (DS) field of the IP header.
 - mandatory
Attributes string - manual
Resume 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
 - receive
Disable string - reverse string
 - Instructs the system to mark the target resource down when the test is successful.
 - security string
 - time
Until numberUp  - 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.
 - base str
 - chase_
referrals str - database str
 - defaults_
from str - destination str
 - id will be full path name of ltm monitor.
 - filename str
 - filter 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.
 - mandatory_
attributes str - 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.
 - security str
 - time_
until_ intup  - 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.
 - adaptive
Limit Number - Displays whether adaptive response time monitoring is enabled for this monitor.
 - base String
 - chase
Referrals String - database String
 - defaults
From String - destination String
 - id will be full path name of ltm monitor.
 - filename String
 - filter 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.
 - ip
Dscp Number - Displays the differentiated services code point (DSCP). DSCP is a 6-bit value in the Differentiated Services (DS) field of the IP header.
 - mandatory
Attributes String - manual
Resume 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
 - receive
Disable String - reverse String
 - Instructs the system to mark the target resource down when the test is successful.
 - security String
 - time
Until NumberUp  - 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 
bigipTerraform Provider.