GtmMonitorTcp

f5 BIG-IP v3.21.0, Apr 20 26

Viewing docs for f5 BIG-IP v3.21.0
published on Monday, Apr 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-f5bigip

Viewing docs for f5 BIG-IP v3.21.0
published on Monday, Apr 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-f5bigip

# f5bigip.GtmMonitorTcp Resource

Provides a BIG-IP GTM (Global Traffic Manager) TCP Monitor resource. This resource allows you to configure and manage GTM TCP health monitors on a BIG-IP system.

Description

A GTM TCP monitor verifies the health of TCP-based services by establishing a connection to the target. It can optionally send a text string and evaluate the response for more specific health checks.

Example Usage

Basic TCP Monitor

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

const example = new f5bigip.GtmMonitorTcp("example", {name: "/Common/my_tcp_monitor"});

import pulumi
import pulumi_f5bigip as f5bigip

example = f5bigip.GtmMonitorTcp("example", name="/Common/my_tcp_monitor")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := f5bigip.NewGtmMonitorTcp(ctx, "example", &f5bigip.GtmMonitorTcpArgs{
			Name: pulumi.String("/Common/my_tcp_monitor"),
		})
		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 example = new F5BigIP.Index.GtmMonitorTcp("example", new()
    {
        Name = "/Common/my_tcp_monitor",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.GtmMonitorTcp;
import com.pulumi.f5bigip.GtmMonitorTcpArgs;
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 example = new GtmMonitorTcp("example", GtmMonitorTcpArgs.builder()
            .name("/Common/my_tcp_monitor")
            .build());

    }
}

resources:
  example:
    type: f5bigip:GtmMonitorTcp
    properties:
      name: /Common/my_tcp_monitor

TCP Monitor with Send/Receive Strings

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

const advanced = new f5bigip.GtmMonitorTcp("advanced", {
    name: "/Common/my_tcp_monitor",
    defaultsFrom: "/Common/tcp",
    destination: "*:3306",
    interval: 10,
    timeout: 60,
    probeTimeout: 3,
    ignoreDownResponse: "disabled",
    transparent: "disabled",
    reverse: "disabled",
    send: "ping",
    receive: "pong",
});

import pulumi
import pulumi_f5bigip as f5bigip

advanced = f5bigip.GtmMonitorTcp("advanced",
    name="/Common/my_tcp_monitor",
    defaults_from="/Common/tcp",
    destination="*:3306",
    interval=10,
    timeout=60,
    probe_timeout=3,
    ignore_down_response="disabled",
    transparent="disabled",
    reverse="disabled",
    send="ping",
    receive="pong")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := f5bigip.NewGtmMonitorTcp(ctx, "advanced", &f5bigip.GtmMonitorTcpArgs{
			Name:               pulumi.String("/Common/my_tcp_monitor"),
			DefaultsFrom:       pulumi.String("/Common/tcp"),
			Destination:        pulumi.String("*:3306"),
			Interval:           pulumi.Int(10),
			Timeout:            pulumi.Int(60),
			ProbeTimeout:       pulumi.Int(3),
			IgnoreDownResponse: pulumi.String("disabled"),
			Transparent:        pulumi.String("disabled"),
			Reverse:            pulumi.String("disabled"),
			Send:               pulumi.String("ping"),
			Receive:            pulumi.String("pong"),
		})
		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 advanced = new F5BigIP.Index.GtmMonitorTcp("advanced", new()
    {
        Name = "/Common/my_tcp_monitor",
        DefaultsFrom = "/Common/tcp",
        Destination = "*:3306",
        Interval = 10,
        Timeout = 60,
        ProbeTimeout = 3,
        IgnoreDownResponse = "disabled",
        Transparent = "disabled",
        Reverse = "disabled",
        Send = "ping",
        Receive = "pong",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.GtmMonitorTcp;
import com.pulumi.f5bigip.GtmMonitorTcpArgs;
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 advanced = new GtmMonitorTcp("advanced", GtmMonitorTcpArgs.builder()
            .name("/Common/my_tcp_monitor")
            .defaultsFrom("/Common/tcp")
            .destination("*:3306")
            .interval(10)
            .timeout(60)
            .probeTimeout(3)
            .ignoreDownResponse("disabled")
            .transparent("disabled")
            .reverse("disabled")
            .send("ping")
            .receive("pong")
            .build());

    }
}

resources:
  advanced:
    type: f5bigip:GtmMonitorTcp
    properties:
      name: /Common/my_tcp_monitor
      defaultsFrom: /Common/tcp
      destination: '*:3306'
      interval: 10
      timeout: 60
      probeTimeout: 3
      ignoreDownResponse: disabled
      transparent: disabled
      reverse: disabled
      send: ping
      receive: pong

Create GtmMonitorTcp Resource

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

Constructor syntax

new GtmMonitorTcp(name: string, args: GtmMonitorTcpArgs, opts?: CustomResourceOptions);

@overload
def GtmMonitorTcp(resource_name: str,
                  args: GtmMonitorTcpArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def GtmMonitorTcp(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  name: Optional[str] = None,
                  defaults_from: Optional[str] = None,
                  destination: Optional[str] = None,
                  ignore_down_response: Optional[str] = None,
                  interval: Optional[int] = None,
                  probe_timeout: Optional[int] = None,
                  receive: Optional[str] = None,
                  reverse: Optional[str] = None,
                  send: Optional[str] = None,
                  timeout: Optional[int] = None,
                  transparent: Optional[str] = None)

func NewGtmMonitorTcp(ctx *Context, name string, args GtmMonitorTcpArgs, opts ...ResourceOption) (*GtmMonitorTcp, error)

public GtmMonitorTcp(string name, GtmMonitorTcpArgs args, CustomResourceOptions? opts = null)

public GtmMonitorTcp(String name, GtmMonitorTcpArgs args)
public GtmMonitorTcp(String name, GtmMonitorTcpArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args GtmMonitorTcpArgs: 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 GtmMonitorTcpArgs: 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 GtmMonitorTcpArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GtmMonitorTcpArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GtmMonitorTcpArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Name string: Name of the GTM TCP monitor
DefaultsFrom string: Inherit properties from this monitor
Destination string: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
IgnoreDownResponse string: Specifies whether the monitor ignores a down response from the system it is monitoring
Interval int: Specifies, in seconds, the frequency at which the system issues the monitor check
ProbeTimeout int: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
Receive string: Specifies the text string that the monitor looks for in the returned resource
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
Timeout int: Specifies the number of seconds the target has in which to respond to the monitor request
Transparent string: Specifies whether the monitor operates in transparent mode

Name string: Name of the GTM TCP monitor
DefaultsFrom string: Inherit properties from this monitor
Destination string: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
IgnoreDownResponse string: Specifies whether the monitor ignores a down response from the system it is monitoring
Interval int: Specifies, in seconds, the frequency at which the system issues the monitor check
ProbeTimeout int: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
Receive string: Specifies the text string that the monitor looks for in the returned resource
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
Timeout int: Specifies the number of seconds the target has in which to respond to the monitor request
Transparent string: Specifies whether the monitor operates in transparent mode

name String: Name of the GTM TCP monitor
defaultsFrom String: Inherit properties from this monitor
destination String: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
ignoreDownResponse String: Specifies whether the monitor ignores a down response from the system it is monitoring
interval Integer: Specifies, in seconds, the frequency at which the system issues the monitor check
probeTimeout Integer: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
receive String: Specifies the text string that the monitor looks for in the returned resource
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
timeout Integer: Specifies the number of seconds the target has in which to respond to the monitor request
transparent String: Specifies whether the monitor operates in transparent mode

name string: Name of the GTM TCP monitor
defaultsFrom string: Inherit properties from this monitor
destination string: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
ignoreDownResponse string: Specifies whether the monitor ignores a down response from the system it is monitoring
interval number: Specifies, in seconds, the frequency at which the system issues the monitor check
probeTimeout number: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
receive string: Specifies the text string that the monitor looks for in the returned resource
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
timeout number: Specifies the number of seconds the target has in which to respond to the monitor request
transparent string: Specifies whether the monitor operates in transparent mode

name str: Name of the GTM TCP monitor
defaults_from str: Inherit properties from this monitor
destination str: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
ignore_down_response str: Specifies whether the monitor ignores a down response from the system it is monitoring
interval int: Specifies, in seconds, the frequency at which the system issues the monitor check
probe_timeout int: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
receive str: Specifies the text string that the monitor looks for in the returned resource
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
timeout int: Specifies the number of seconds the target has in which to respond to the monitor request
transparent str: Specifies whether the monitor operates in transparent mode

name String: Name of the GTM TCP monitor
defaultsFrom String: Inherit properties from this monitor
destination String: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
ignoreDownResponse String: Specifies whether the monitor ignores a down response from the system it is monitoring
interval Number: Specifies, in seconds, the frequency at which the system issues the monitor check
probeTimeout Number: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
receive String: Specifies the text string that the monitor looks for in the returned resource
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
timeout Number: Specifies the number of seconds the target has in which to respond to the monitor request
transparent String: Specifies whether the monitor operates in transparent mode

Outputs

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

Get an existing GtmMonitorTcp 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?: GtmMonitorTcpState, opts?: CustomResourceOptions): GtmMonitorTcp

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        defaults_from: Optional[str] = None,
        destination: Optional[str] = None,
        ignore_down_response: Optional[str] = None,
        interval: Optional[int] = None,
        name: Optional[str] = None,
        probe_timeout: Optional[int] = None,
        receive: Optional[str] = None,
        reverse: Optional[str] = None,
        send: Optional[str] = None,
        timeout: Optional[int] = None,
        transparent: Optional[str] = None) -> GtmMonitorTcp

func GetGtmMonitorTcp(ctx *Context, name string, id IDInput, state *GtmMonitorTcpState, opts ...ResourceOption) (*GtmMonitorTcp, error)

public static GtmMonitorTcp Get(string name, Input<string> id, GtmMonitorTcpState? state, CustomResourceOptions? opts = null)

public static GtmMonitorTcp get(String name, Output<String> id, GtmMonitorTcpState state, CustomResourceOptions options)

resources:  _:    type: f5bigip:GtmMonitorTcp    get:      id: ${id}

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:

DefaultsFrom string: Inherit properties from this monitor
Destination string: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
IgnoreDownResponse string: Specifies whether the monitor ignores a down response from the system it is monitoring
Interval int: Specifies, in seconds, the frequency at which the system issues the monitor check
Name string: Name of the GTM TCP monitor
ProbeTimeout int: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
Receive string: Specifies the text string that the monitor looks for in the returned resource
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
Timeout int: Specifies the number of seconds the target has in which to respond to the monitor request
Transparent string: Specifies whether the monitor operates in transparent mode

DefaultsFrom string: Inherit properties from this monitor
Destination string: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
IgnoreDownResponse string: Specifies whether the monitor ignores a down response from the system it is monitoring
Interval int: Specifies, in seconds, the frequency at which the system issues the monitor check
Name string: Name of the GTM TCP monitor
ProbeTimeout int: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
Receive string: Specifies the text string that the monitor looks for in the returned resource
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
Timeout int: Specifies the number of seconds the target has in which to respond to the monitor request
Transparent string: Specifies whether the monitor operates in transparent mode

defaultsFrom String: Inherit properties from this monitor
destination String: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
ignoreDownResponse String: Specifies whether the monitor ignores a down response from the system it is monitoring
interval Integer: Specifies, in seconds, the frequency at which the system issues the monitor check
name String: Name of the GTM TCP monitor
probeTimeout Integer: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
receive String: Specifies the text string that the monitor looks for in the returned resource
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
timeout Integer: Specifies the number of seconds the target has in which to respond to the monitor request
transparent String: Specifies whether the monitor operates in transparent mode

defaultsFrom string: Inherit properties from this monitor
destination string: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
ignoreDownResponse string: Specifies whether the monitor ignores a down response from the system it is monitoring
interval number: Specifies, in seconds, the frequency at which the system issues the monitor check
name string: Name of the GTM TCP monitor
probeTimeout number: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
receive string: Specifies the text string that the monitor looks for in the returned resource
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
timeout number: Specifies the number of seconds the target has in which to respond to the monitor request
transparent string: Specifies whether the monitor operates in transparent mode

defaults_from str: Inherit properties from this monitor
destination str: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
ignore_down_response str: Specifies whether the monitor ignores a down response from the system it is monitoring
interval int: Specifies, in seconds, the frequency at which the system issues the monitor check
name str: Name of the GTM TCP monitor
probe_timeout int: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
receive str: Specifies the text string that the monitor looks for in the returned resource
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
timeout int: Specifies the number of seconds the target has in which to respond to the monitor request
transparent str: Specifies whether the monitor operates in transparent mode

defaultsFrom String: Inherit properties from this monitor
destination String: Specifies the IP address and service port of the resource that is the destination of this monitor. Format: ip:port. Default is ":"
ignoreDownResponse String: Specifies whether the monitor ignores a down response from the system it is monitoring
interval Number: Specifies, in seconds, the frequency at which the system issues the monitor check
name String: Name of the GTM TCP monitor
probeTimeout Number: Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system
receive String: Specifies the text string that the monitor looks for in the returned resource
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
timeout Number: Specifies the number of seconds the target has in which to respond to the monitor request
transparent String: Specifies whether the monitor operates in transparent mode

Import

GTM TCP Monitor resources can be imported using the full path name:

$ pulumi import f5bigip:index/gtmMonitorTcp:GtmMonitorTcp example /Common/my_tcp_monitor

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.

Viewing docs for f5 BIG-IP v3.21.0
published on Monday, Apr 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-f5bigip

f5bigip.GtmMonitorTcp

On this page

On this page

# f5bigip.GtmMonitorTcp Resource

Description

Example Usage

Basic TCP Monitor

TCP Monitor with Send/Receive Strings

Create GtmMonitorTcp Resource

Constructor syntax

Parameters

GtmMonitorTcp Resource Properties

Inputs

Outputs

Look up Existing GtmMonitorTcp Resource

Import

Package Details

On this page

On this page