Viewing docs for f5 BIG-IP v3.21.0
published on Monday, Apr 20, 2026 by Pulumi
published on Monday, Apr 20, 2026 by Pulumi
Viewing docs for f5 BIG-IP v3.21.0
published on Monday, Apr 20, 2026 by Pulumi
published on Monday, Apr 20, 2026 by Pulumi
# f5bigip.GtmMonitorBigip Resource
Provides a BIG-IP GTM (Global Traffic Manager) BIG-IP Monitor resource. This resource allows you to configure and manage GTM BIG-IP monitors on a BIG-IP system.
Description
A GTM BIG-IP monitor is both a health and performance monitor that acquires data captured through monitors managed by a BIG-IP Local Traffic Manager.
You can monitor only the following components with a BIG-IP monitor:
- Global Traffic Manager server
- Global Traffic Manager virtual server
- Local Traffic Manager server
- Local Traffic Manager virtual server
Example Usage
Basic BIG-IP Monitor
import * as pulumi from "@pulumi/pulumi";
import * as f5bigip from "@pulumi/f5bigip";
const example = new f5bigip.GtmMonitorBigip("example", {name: "/Common/my_bigip_monitor"});
import pulumi
import pulumi_f5bigip as f5bigip
example = f5bigip.GtmMonitorBigip("example", name="/Common/my_bigip_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.NewGtmMonitorBigip(ctx, "example", &f5bigip.GtmMonitorBigipArgs{
Name: pulumi.String("/Common/my_bigip_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.GtmMonitorBigip("example", new()
{
Name = "/Common/my_bigip_monitor",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.GtmMonitorBigip;
import com.pulumi.f5bigip.GtmMonitorBigipArgs;
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 GtmMonitorBigip("example", GtmMonitorBigipArgs.builder()
.name("/Common/my_bigip_monitor")
.build());
}
}
resources:
example:
type: f5bigip:GtmMonitorBigip
properties:
name: /Common/my_bigip_monitor
Full BIG-IP Monitor Configuration
import * as pulumi from "@pulumi/pulumi";
import * as f5bigip from "@pulumi/f5bigip";
const advanced = new f5bigip.GtmMonitorBigip("advanced", {
name: "/Common/my_bigip_monitor",
defaultsFrom: "/Common/bigip",
destination: "*:*",
interval: 10,
timeout: 30,
ignoreDownResponse: "disabled",
aggregationType: "average-nodes",
});
import pulumi
import pulumi_f5bigip as f5bigip
advanced = f5bigip.GtmMonitorBigip("advanced",
name="/Common/my_bigip_monitor",
defaults_from="/Common/bigip",
destination="*:*",
interval=10,
timeout=30,
ignore_down_response="disabled",
aggregation_type="average-nodes")
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.NewGtmMonitorBigip(ctx, "advanced", &f5bigip.GtmMonitorBigipArgs{
Name: pulumi.String("/Common/my_bigip_monitor"),
DefaultsFrom: pulumi.String("/Common/bigip"),
Destination: pulumi.String("*:*"),
Interval: pulumi.Int(10),
Timeout: pulumi.Int(30),
IgnoreDownResponse: pulumi.String("disabled"),
AggregationType: pulumi.String("average-nodes"),
})
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.GtmMonitorBigip("advanced", new()
{
Name = "/Common/my_bigip_monitor",
DefaultsFrom = "/Common/bigip",
Destination = "*:*",
Interval = 10,
Timeout = 30,
IgnoreDownResponse = "disabled",
AggregationType = "average-nodes",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.GtmMonitorBigip;
import com.pulumi.f5bigip.GtmMonitorBigipArgs;
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 GtmMonitorBigip("advanced", GtmMonitorBigipArgs.builder()
.name("/Common/my_bigip_monitor")
.defaultsFrom("/Common/bigip")
.destination("*:*")
.interval(10)
.timeout(30)
.ignoreDownResponse("disabled")
.aggregationType("average-nodes")
.build());
}
}
resources:
advanced:
type: f5bigip:GtmMonitorBigip
properties:
name: /Common/my_bigip_monitor
defaultsFrom: /Common/bigip
destination: '*:*'
interval: 10
timeout: 30
ignoreDownResponse: disabled
aggregationType: average-nodes
Create GtmMonitorBigip Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GtmMonitorBigip(name: string, args: GtmMonitorBigipArgs, opts?: CustomResourceOptions);@overload
def GtmMonitorBigip(resource_name: str,
args: GtmMonitorBigipArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GtmMonitorBigip(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
aggregation_type: Optional[str] = None,
defaults_from: Optional[str] = None,
destination: Optional[str] = None,
ignore_down_response: Optional[str] = None,
interval: Optional[int] = None,
timeout: Optional[int] = None)func NewGtmMonitorBigip(ctx *Context, name string, args GtmMonitorBigipArgs, opts ...ResourceOption) (*GtmMonitorBigip, error)public GtmMonitorBigip(string name, GtmMonitorBigipArgs args, CustomResourceOptions? opts = null)
public GtmMonitorBigip(String name, GtmMonitorBigipArgs args)
public GtmMonitorBigip(String name, GtmMonitorBigipArgs args, CustomResourceOptions options)
type: f5bigip:GtmMonitorBigip
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 GtmMonitorBigipArgs
- 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 GtmMonitorBigipArgs
- 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 GtmMonitorBigipArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GtmMonitorBigipArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GtmMonitorBigipArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
GtmMonitorBigip 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 GtmMonitorBigip resource accepts the following input properties:
- Name string
- Name of the GTM BIG-IP monitor
- Aggregation
Type string - Specifies how the system combines monitor information for a monitored pool. The default is none
- Defaults
From 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 ":"
- Ignore
Down stringResponse - 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
- Timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- Name string
- Name of the GTM BIG-IP monitor
- Aggregation
Type string - Specifies how the system combines monitor information for a monitored pool. The default is none
- Defaults
From 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 ":"
- Ignore
Down stringResponse - 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
- Timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- name String
- Name of the GTM BIG-IP monitor
- aggregation
Type String - Specifies how the system combines monitor information for a monitored pool. The default is none
- defaults
From 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 ":"
- ignore
Down StringResponse - 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
- timeout Integer
- Specifies the number of seconds the target has in which to respond to the monitor request
- name string
- Name of the GTM BIG-IP monitor
- aggregation
Type string - Specifies how the system combines monitor information for a monitored pool. The default is none
- defaults
From 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 ":"
- ignore
Down stringResponse - 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
- timeout number
- Specifies the number of seconds the target has in which to respond to the monitor request
- name str
- Name of the GTM BIG-IP monitor
- aggregation_
type str - Specifies how the system combines monitor information for a monitored pool. The default is none
- 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_ strresponse - 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
- timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- name String
- Name of the GTM BIG-IP monitor
- aggregation
Type String - Specifies how the system combines monitor information for a monitored pool. The default is none
- defaults
From 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 ":"
- ignore
Down StringResponse - 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
- timeout Number
- Specifies the number of seconds the target has in which to respond to the monitor request
Outputs
All input properties are implicitly available as output properties. Additionally, the GtmMonitorBigip 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 GtmMonitorBigip Resource
Get an existing GtmMonitorBigip 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?: GtmMonitorBigipState, opts?: CustomResourceOptions): GtmMonitorBigip@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aggregation_type: Optional[str] = None,
defaults_from: Optional[str] = None,
destination: Optional[str] = None,
ignore_down_response: Optional[str] = None,
interval: Optional[int] = None,
name: Optional[str] = None,
timeout: Optional[int] = None) -> GtmMonitorBigipfunc GetGtmMonitorBigip(ctx *Context, name string, id IDInput, state *GtmMonitorBigipState, opts ...ResourceOption) (*GtmMonitorBigip, error)public static GtmMonitorBigip Get(string name, Input<string> id, GtmMonitorBigipState? state, CustomResourceOptions? opts = null)public static GtmMonitorBigip get(String name, Output<String> id, GtmMonitorBigipState state, CustomResourceOptions options)resources: _: type: f5bigip:GtmMonitorBigip 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.
- Aggregation
Type string - Specifies how the system combines monitor information for a monitored pool. The default is none
- Defaults
From 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 ":"
- Ignore
Down stringResponse - 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 BIG-IP monitor
- Timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- Aggregation
Type string - Specifies how the system combines monitor information for a monitored pool. The default is none
- Defaults
From 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 ":"
- Ignore
Down stringResponse - 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 BIG-IP monitor
- Timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- aggregation
Type String - Specifies how the system combines monitor information for a monitored pool. The default is none
- defaults
From 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 ":"
- ignore
Down StringResponse - 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 BIG-IP monitor
- timeout Integer
- Specifies the number of seconds the target has in which to respond to the monitor request
- aggregation
Type string - Specifies how the system combines monitor information for a monitored pool. The default is none
- defaults
From 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 ":"
- ignore
Down stringResponse - 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 BIG-IP monitor
- timeout number
- Specifies the number of seconds the target has in which to respond to the monitor request
- aggregation_
type str - Specifies how the system combines monitor information for a monitored pool. The default is none
- 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_ strresponse - 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 BIG-IP monitor
- timeout int
- Specifies the number of seconds the target has in which to respond to the monitor request
- aggregation
Type String - Specifies how the system combines monitor information for a monitored pool. The default is none
- defaults
From 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 ":"
- ignore
Down StringResponse - 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 BIG-IP monitor
- timeout Number
- Specifies the number of seconds the target has in which to respond to the monitor request
Import
GTM BIG-IP Monitor resources can be imported using the full path name:
$ pulumi import f5bigip:index/gtmMonitorBigip:GtmMonitorBigip example /Common/my_bigip_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
bigipTerraform Provider.
Viewing docs for f5 BIG-IP v3.21.0
published on Monday, Apr 20, 2026 by Pulumi
published on Monday, Apr 20, 2026 by Pulumi
