f5 BIG-IP v3.17.10, Apr 8 25

f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi

f5bigip.ltm.PoolAttachment

Explore with Pulumi AI

f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-f5bigip

Example Usage
Usage Pool attachment with node/member directly attaching to pool.
Usage Pool attachment with node referenced from f5bigip.ltm.Node
Create PoolAttachment Resource
Constructor syntax
Constructor example
PoolAttachment Resource Properties
Inputs
Outputs
Look up Existing PoolAttachment Resource
Import
Package Details

Request a Change

f5bigip.ltm.PoolAttachment Manages nodes membership in pools

Example Usage

There are two ways to use f5bigip.ltm.PoolAttachment resource for node attribute

It can be reference from f5bigip.ltm.Node (or)
It can be specify directly with ipv4:port/fqdn:port/ipv6.port which will also create node and attach member to pool.

For adding IPv6 node/member to pool it should be specific in node attribute in format like ipv6_address.port. IPv4 should be specified as ipv4_address:port

Usage Pool attachment with node/member directly attaching to pool.

node can be specified in format ipv4:port / fqdn:port / ipv6.port

TypeScript
Python
Go
C#
Java
YAML

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

const monitor = new f5bigip.ltm.Monitor("monitor", {
    name: "/Common/terraform_monitor",
    parent: "/Common/http",
    send: "GET /some/path\x0d\n",
    timeout: 999,
    interval: 998,
});
const pool = new f5bigip.ltm.Pool("pool", {
    name: "/Common/terraform-pool",
    loadBalancingMode: "round-robin",
    monitors: [monitor.name],
    allowSnat: "yes",
    allowNat: "yes",
});
// attaching ipv4 address with service port
const ipv4NodeAttach = new f5bigip.ltm.PoolAttachment("ipv4_node_attach", {
    pool: pool.name,
    node: "1.1.1.1:80",
});
// attaching ipv6 address with service port
const ipv6NodeAttach = new f5bigip.ltm.PoolAttachment("ipv6_node_attach", {
    pool: pool.name,
    node: "2003::4.80",
});

import pulumi
import pulumi_f5bigip as f5bigip

monitor = f5bigip.ltm.Monitor("monitor",
    name="/Common/terraform_monitor",
    parent="/Common/http",
    send="GET /some/path\x0d\n",
    timeout=999,
    interval=998)
pool = f5bigip.ltm.Pool("pool",
    name="/Common/terraform-pool",
    load_balancing_mode="round-robin",
    monitors=[monitor.name],
    allow_snat="yes",
    allow_nat="yes")
# attaching ipv4 address with service port
ipv4_node_attach = f5bigip.ltm.PoolAttachment("ipv4_node_attach",
    pool=pool.name,
    node="1.1.1.1:80")
# attaching ipv6 address with service port
ipv6_node_attach = f5bigip.ltm.PoolAttachment("ipv6_node_attach",
    pool=pool.name,
    node="2003::4.80")

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 {
		monitor, err := ltm.NewMonitor(ctx, "monitor", &ltm.MonitorArgs{
			Name:     pulumi.String("/Common/terraform_monitor"),
			Parent:   pulumi.String("/Common/http"),
			Send:     pulumi.String("GET /some/path
\n"),
			Timeout:  pulumi.Int(999),
			Interval: pulumi.Int(998),
		})
		if err != nil {
			return err
		}
		pool, err := ltm.NewPool(ctx, "pool", &ltm.PoolArgs{
			Name:              pulumi.String("/Common/terraform-pool"),
			LoadBalancingMode: pulumi.String("round-robin"),
			Monitors: pulumi.StringArray{
				monitor.Name,
			},
			AllowSnat: pulumi.String("yes"),
			AllowNat:  pulumi.String("yes"),
		})
		if err != nil {
			return err
		}
		// attaching ipv4 address with service port
		_, err = ltm.NewPoolAttachment(ctx, "ipv4_node_attach", &ltm.PoolAttachmentArgs{
			Pool: pool.Name,
			Node: pulumi.String("1.1.1.1:80"),
		})
		if err != nil {
			return err
		}
		// attaching ipv6 address with service port
		_, err = ltm.NewPoolAttachment(ctx, "ipv6_node_attach", &ltm.PoolAttachmentArgs{
			Pool: pool.Name,
			Node: pulumi.String("2003::4.80"),
		})
		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 = new F5BigIP.Ltm.Monitor("monitor", new()
    {
        Name = "/Common/terraform_monitor",
        Parent = "/Common/http",
        Send = @"GET /some/path
",
        Timeout = 999,
        Interval = 998,
    });

    var pool = new F5BigIP.Ltm.Pool("pool", new()
    {
        Name = "/Common/terraform-pool",
        LoadBalancingMode = "round-robin",
        Monitors = new[]
        {
            monitor.Name,
        },
        AllowSnat = "yes",
        AllowNat = "yes",
    });

    // attaching ipv4 address with service port
    var ipv4NodeAttach = new F5BigIP.Ltm.PoolAttachment("ipv4_node_attach", new()
    {
        Pool = pool.Name,
        Node = "1.1.1.1:80",
    });

    // attaching ipv6 address with service port
    var ipv6NodeAttach = new F5BigIP.Ltm.PoolAttachment("ipv6_node_attach", new()
    {
        Pool = pool.Name,
        Node = "2003::4.80",
    });

});

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 com.pulumi.f5bigip.ltm.Pool;
import com.pulumi.f5bigip.ltm.PoolArgs;
import com.pulumi.f5bigip.ltm.PoolAttachment;
import com.pulumi.f5bigip.ltm.PoolAttachmentArgs;
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()
            .name("/Common/terraform_monitor")
            .parent("/Common/http")
            .send("""
GET /some/path
            """)
            .timeout("999")
            .interval("998")
            .build());

        var pool = new Pool("pool", PoolArgs.builder()
            .name("/Common/terraform-pool")
            .loadBalancingMode("round-robin")
            .monitors(monitor.name())
            .allowSnat("yes")
            .allowNat("yes")
            .build());

        // attaching ipv4 address with service port
        var ipv4NodeAttach = new PoolAttachment("ipv4NodeAttach", PoolAttachmentArgs.builder()
            .pool(pool.name())
            .node("1.1.1.1:80")
            .build());

        // attaching ipv6 address with service port
        var ipv6NodeAttach = new PoolAttachment("ipv6NodeAttach", PoolAttachmentArgs.builder()
            .pool(pool.name())
            .node("2003::4.80")
            .build());

    }
}

resources:
  monitor:
    type: f5bigip:ltm:Monitor
    properties:
      name: /Common/terraform_monitor
      parent: /Common/http
      send: "GET /some/path\r\n"
      timeout: '999'
      interval: '998'
  pool:
    type: f5bigip:ltm:Pool
    properties:
      name: /Common/terraform-pool
      loadBalancingMode: round-robin
      monitors:
        - ${monitor.name}
      allowSnat: yes
      allowNat: yes
  # attaching ipv4 address with service port
  ipv4NodeAttach:
    type: f5bigip:ltm:PoolAttachment
    name: ipv4_node_attach
    properties:
      pool: ${pool.name}
      node: 1.1.1.1:80
  # attaching ipv6 address with service port
  ipv6NodeAttach:
    type: f5bigip:ltm:PoolAttachment
    name: ipv6_node_attach
    properties:
      pool: ${pool.name}
      node: 2003::4.80

Usage Pool attachment with node referenced from `f5bigip.ltm.Node`

TypeScript
Python
Go
C#
Java
YAML

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

const monitor = new f5bigip.ltm.Monitor("monitor", {
    name: "/Common/terraform_monitor",
    parent: "/Common/http",
    send: "GET /some/path\x0d\n",
    timeout: 999,
    interval: 998,
});
const pool = new f5bigip.ltm.Pool("pool", {
    name: "/Common/terraform-pool",
    loadBalancingMode: "round-robin",
    monitors: [monitor.name],
    allowSnat: "yes",
    allowNat: "yes",
});
const node = new f5bigip.ltm.Node("node", {
    name: "/Common/terraform_node",
    address: "192.168.30.2",
});
const attachNode = new f5bigip.ltm.PoolAttachment("attach_node", {
    pool: pool.name,
    node: pulumi.interpolate`${node.name}:80`,
});

import pulumi
import pulumi_f5bigip as f5bigip

monitor = f5bigip.ltm.Monitor("monitor",
    name="/Common/terraform_monitor",
    parent="/Common/http",
    send="GET /some/path\x0d\n",
    timeout=999,
    interval=998)
pool = f5bigip.ltm.Pool("pool",
    name="/Common/terraform-pool",
    load_balancing_mode="round-robin",
    monitors=[monitor.name],
    allow_snat="yes",
    allow_nat="yes")
node = f5bigip.ltm.Node("node",
    name="/Common/terraform_node",
    address="192.168.30.2")
attach_node = f5bigip.ltm.PoolAttachment("attach_node",
    pool=pool.name,
    node=node.name.apply(lambda name: f"{name}:80"))

package main

import (
	"fmt"

	"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 {
		monitor, err := ltm.NewMonitor(ctx, "monitor", &ltm.MonitorArgs{
			Name:     pulumi.String("/Common/terraform_monitor"),
			Parent:   pulumi.String("/Common/http"),
			Send:     pulumi.String("GET /some/path
\n"),
			Timeout:  pulumi.Int(999),
			Interval: pulumi.Int(998),
		})
		if err != nil {
			return err
		}
		pool, err := ltm.NewPool(ctx, "pool", &ltm.PoolArgs{
			Name:              pulumi.String("/Common/terraform-pool"),
			LoadBalancingMode: pulumi.String("round-robin"),
			Monitors: pulumi.StringArray{
				monitor.Name,
			},
			AllowSnat: pulumi.String("yes"),
			AllowNat:  pulumi.String("yes"),
		})
		if err != nil {
			return err
		}
		node, err := ltm.NewNode(ctx, "node", &ltm.NodeArgs{
			Name:    pulumi.String("/Common/terraform_node"),
			Address: pulumi.String("192.168.30.2"),
		})
		if err != nil {
			return err
		}
		_, err = ltm.NewPoolAttachment(ctx, "attach_node", &ltm.PoolAttachmentArgs{
			Pool: pool.Name,
			Node: node.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("%v:80", name), nil
			}).(pulumi.StringOutput),
		})
		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 = new F5BigIP.Ltm.Monitor("monitor", new()
    {
        Name = "/Common/terraform_monitor",
        Parent = "/Common/http",
        Send = @"GET /some/path
",
        Timeout = 999,
        Interval = 998,
    });

    var pool = new F5BigIP.Ltm.Pool("pool", new()
    {
        Name = "/Common/terraform-pool",
        LoadBalancingMode = "round-robin",
        Monitors = new[]
        {
            monitor.Name,
        },
        AllowSnat = "yes",
        AllowNat = "yes",
    });

    var node = new F5BigIP.Ltm.Node("node", new()
    {
        Name = "/Common/terraform_node",
        Address = "192.168.30.2",
    });

    var attachNode = new F5BigIP.Ltm.PoolAttachment("attach_node", new()
    {
        Pool = pool.Name,
        Node = node.Name.Apply(name => $"{name}:80"),
    });

});

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 com.pulumi.f5bigip.ltm.Pool;
import com.pulumi.f5bigip.ltm.PoolArgs;
import com.pulumi.f5bigip.ltm.Node;
import com.pulumi.f5bigip.ltm.NodeArgs;
import com.pulumi.f5bigip.ltm.PoolAttachment;
import com.pulumi.f5bigip.ltm.PoolAttachmentArgs;
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()
            .name("/Common/terraform_monitor")
            .parent("/Common/http")
            .send("""
GET /some/path
            """)
            .timeout("999")
            .interval("998")
            .build());

        var pool = new Pool("pool", PoolArgs.builder()
            .name("/Common/terraform-pool")
            .loadBalancingMode("round-robin")
            .monitors(monitor.name())
            .allowSnat("yes")
            .allowNat("yes")
            .build());

        var node = new Node("node", NodeArgs.builder()
            .name("/Common/terraform_node")
            .address("192.168.30.2")
            .build());

        var attachNode = new PoolAttachment("attachNode", PoolAttachmentArgs.builder()
            .pool(pool.name())
            .node(node.name().applyValue(name -> String.format("%s:80", name)))
            .build());

    }
}

resources:
  monitor:
    type: f5bigip:ltm:Monitor
    properties:
      name: /Common/terraform_monitor
      parent: /Common/http
      send: "GET /some/path\r\n"
      timeout: '999'
      interval: '998'
  pool:
    type: f5bigip:ltm:Pool
    properties:
      name: /Common/terraform-pool
      loadBalancingMode: round-robin
      monitors:
        - ${monitor.name}
      allowSnat: yes
      allowNat: yes
  node:
    type: f5bigip:ltm:Node
    properties:
      name: /Common/terraform_node
      address: 192.168.30.2
  attachNode:
    type: f5bigip:ltm:PoolAttachment
    name: attach_node
    properties:
      pool: ${pool.name}
      node: ${node.name}:80

Create PoolAttachment Resource

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

new PoolAttachment(name: string, args: PoolAttachmentArgs, opts?: CustomResourceOptions);

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

@overload
def PoolAttachment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   node: Optional[str] = None,
                   pool: Optional[str] = None,
                   connection_limit: Optional[int] = None,
                   connection_rate_limit: Optional[str] = None,
                   dynamic_ratio: Optional[int] = None,
                   fqdn_autopopulate: Optional[str] = None,
                   monitor: Optional[str] = None,
                   priority_group: Optional[int] = None,
                   ratio: Optional[int] = None,
                   state: Optional[str] = None)

func NewPoolAttachment(ctx *Context, name string, args PoolAttachmentArgs, opts ...ResourceOption) (*PoolAttachment, error)

public PoolAttachment(string name, PoolAttachmentArgs args, CustomResourceOptions? opts = null)

public PoolAttachment(String name, PoolAttachmentArgs args)
public PoolAttachment(String name, PoolAttachmentArgs args, CustomResourceOptions options)

type: f5bigip:ltm:PoolAttachment
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 PoolAttachmentArgs: 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 PoolAttachmentArgs: 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 PoolAttachmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

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

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var poolAttachmentResource = new F5BigIP.Ltm.PoolAttachment("poolAttachmentResource", new()
{
    Node = "string",
    Pool = "string",
    ConnectionLimit = 0,
    ConnectionRateLimit = "string",
    DynamicRatio = 0,
    FqdnAutopopulate = "string",
    Monitor = "string",
    PriorityGroup = 0,
    Ratio = 0,
    State = "string",
});

example, err := ltm.NewPoolAttachment(ctx, "poolAttachmentResource", &ltm.PoolAttachmentArgs{
	Node:                pulumi.String("string"),
	Pool:                pulumi.String("string"),
	ConnectionLimit:     pulumi.Int(0),
	ConnectionRateLimit: pulumi.String("string"),
	DynamicRatio:        pulumi.Int(0),
	FqdnAutopopulate:    pulumi.String("string"),
	Monitor:             pulumi.String("string"),
	PriorityGroup:       pulumi.Int(0),
	Ratio:               pulumi.Int(0),
	State:               pulumi.String("string"),
})

var poolAttachmentResource = new PoolAttachment("poolAttachmentResource", PoolAttachmentArgs.builder()
    .node("string")
    .pool("string")
    .connectionLimit(0)
    .connectionRateLimit("string")
    .dynamicRatio(0)
    .fqdnAutopopulate("string")
    .monitor("string")
    .priorityGroup(0)
    .ratio(0)
    .state("string")
    .build());

pool_attachment_resource = f5bigip.ltm.PoolAttachment("poolAttachmentResource",
    node="string",
    pool="string",
    connection_limit=0,
    connection_rate_limit="string",
    dynamic_ratio=0,
    fqdn_autopopulate="string",
    monitor="string",
    priority_group=0,
    ratio=0,
    state="string")

const poolAttachmentResource = new f5bigip.ltm.PoolAttachment("poolAttachmentResource", {
    node: "string",
    pool: "string",
    connectionLimit: 0,
    connectionRateLimit: "string",
    dynamicRatio: 0,
    fqdnAutopopulate: "string",
    monitor: "string",
    priorityGroup: 0,
    ratio: 0,
    state: "string",
});

type: f5bigip:ltm:PoolAttachment
properties:
    connectionLimit: 0
    connectionRateLimit: string
    dynamicRatio: 0
    fqdnAutopopulate: string
    monitor: string
    node: string
    pool: string
    priorityGroup: 0
    ratio: 0
    state: string

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

Node string: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
Pool string: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
ConnectionLimit int: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
ConnectionRateLimit string: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
DynamicRatio int: Specifies the fixed ratio value used for a node during ratio load balancing.
FqdnAutopopulate string: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
Monitor string: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
PriorityGroup int: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
Ratio int: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
State string: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

Node string: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
Pool string: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
ConnectionLimit int: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
ConnectionRateLimit string: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
DynamicRatio int: Specifies the fixed ratio value used for a node during ratio load balancing.
FqdnAutopopulate string: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
Monitor string: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
PriorityGroup int: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
Ratio int: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
State string: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

node String: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
pool String: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
connectionLimit Integer: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
connectionRateLimit String: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
dynamicRatio Integer: Specifies the fixed ratio value used for a node during ratio load balancing.
fqdnAutopopulate String: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
monitor String: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
priorityGroup Integer: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
ratio Integer: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
state String: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

node string: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
pool string: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
connectionLimit number: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
connectionRateLimit string: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
dynamicRatio number: Specifies the fixed ratio value used for a node during ratio load balancing.
fqdnAutopopulate string: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
monitor string: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
priorityGroup number: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
ratio number: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
state string: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

node str: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
pool str: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
connection_limit int: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
connection_rate_limit str: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
dynamic_ratio int: Specifies the fixed ratio value used for a node during ratio load balancing.
fqdn_autopopulate str: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
monitor str: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
priority_group int: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
ratio int: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
state str: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

node String: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
pool String: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
connectionLimit Number: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
connectionRateLimit String: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
dynamicRatio Number: Specifies the fixed ratio value used for a node during ratio load balancing.
fqdnAutopopulate String: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
monitor String: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
priorityGroup Number: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
ratio Number: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
state String: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

Outputs

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

Get an existing PoolAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: PoolAttachmentState, opts?: CustomResourceOptions): PoolAttachment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_limit: Optional[int] = None,
        connection_rate_limit: Optional[str] = None,
        dynamic_ratio: Optional[int] = None,
        fqdn_autopopulate: Optional[str] = None,
        monitor: Optional[str] = None,
        node: Optional[str] = None,
        pool: Optional[str] = None,
        priority_group: Optional[int] = None,
        ratio: Optional[int] = None,
        state: Optional[str] = None) -> PoolAttachment

func GetPoolAttachment(ctx *Context, name string, id IDInput, state *PoolAttachmentState, opts ...ResourceOption) (*PoolAttachment, error)

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

public static PoolAttachment get(String name, Output<String> id, PoolAttachmentState state, CustomResourceOptions options)

resources:  _:    type: f5bigip:ltm:PoolAttachment    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:

ConnectionLimit int: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
ConnectionRateLimit string: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
DynamicRatio int: Specifies the fixed ratio value used for a node during ratio load balancing.
FqdnAutopopulate string: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
Monitor string: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
Node string: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
Pool string: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
PriorityGroup int: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
Ratio int: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
State string: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

ConnectionLimit int: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
ConnectionRateLimit string: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
DynamicRatio int: Specifies the fixed ratio value used for a node during ratio load balancing.
FqdnAutopopulate string: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
Monitor string: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
Node string: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
Pool string: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
PriorityGroup int: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
Ratio int: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
State string: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

connectionLimit Integer: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
connectionRateLimit String: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
dynamicRatio Integer: Specifies the fixed ratio value used for a node during ratio load balancing.
fqdnAutopopulate String: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
monitor String: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
node String: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
pool String: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
priorityGroup Integer: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
ratio Integer: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
state String: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

connectionLimit number: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
connectionRateLimit string: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
dynamicRatio number: Specifies the fixed ratio value used for a node during ratio load balancing.
fqdnAutopopulate string: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
monitor string: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
node string: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
pool string: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
priorityGroup number: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
ratio number: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
state string: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

connection_limit int: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
connection_rate_limit str: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
dynamic_ratio int: Specifies the fixed ratio value used for a node during ratio load balancing.
fqdn_autopopulate str: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
monitor str: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
node str: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
pool str: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
priority_group int: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
ratio int: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
state str: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

connectionLimit Number: Specifies a maximum established connection limit for a pool member or node.The default is 0, meaning that there is no limit to the number of connections.
connectionRateLimit String: Specifies the maximum number of connections-per-second allowed for a pool member,The default is 0.
dynamicRatio Number: Specifies the fixed ratio value used for a node during ratio load balancing.
fqdnAutopopulate String: Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. The default is enabled
monitor String: Specifies the health monitors that the system uses to monitor this pool member,value can be none (or) default (or) list of monitors joined with and ( ex: /Common/test_monitor_pa_tc1 and /Common/gateway_icmp).
node String: Pool member address/fqdn with service port, (ex: 1.1.1.1:80/www.google.com:80). (Note: Member will be in same partition of Pool)
pool String: Name of the pool to which members should be attached,it should be "full path".The full path is the combination of the partition + name of the pool.(For example /Common/my-pool) or partition + directory + name of the pool (For example /Common/test/my-pool).When including directory in fullpath we have to make sure it is created in the given partition before using it.
priorityGroup Number: Specifies a number representing the priority group for the pool member. The default is 0, meaning that the member has no priority
ratio Number: "Specifies the ratio weight to assign to the pool member. Valid values range from 1 through 65535. The default is 1, which means that each pool member has an equal ratio proportion.".
state String: Specifies the state the pool member should be in,value can be enabled (or) disabled (or) forced_offline).

Import

ing

An existing pool attachment (i.e. pool membership) can be imported into this resource by supplying both the pool full path, and the node full path with the relevant port. If the pool or node membership is not found, an error will be returned. An example is below:

$ terraform import bigip_ltm_pool_attachment.node-pool-attach \
	'{"pool": "/Common/terraform-pool", "node": "/Common/node1:80"}'

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.

f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-f5bigip

Example Usage
Usage Pool attachment with node/member directly attaching to pool.
Usage Pool attachment with node referenced from f5bigip.ltm.Node
Create PoolAttachment Resource
Constructor syntax
Constructor example
PoolAttachment Resource Properties
Inputs
Outputs
Look up Existing PoolAttachment Resource
Import
Package Details

Request a Change

f5bigip.ltm.PoolAttachment

On this page

On this page

Example Usage

Usage Pool attachment with node/member directly attaching to pool.

Usage Pool attachment with node referenced from `f5bigip.ltm.Node`

Create PoolAttachment Resource

Constructor syntax

Parameters

Constructor example

PoolAttachment Resource Properties

Inputs

Outputs

Look up Existing PoolAttachment Resource

Import

Package Details

On this page

On this page

f5bigip.ltm.PoolAttachment

On this page

On this page

Example Usage

Usage Pool attachment with node/member directly attaching to pool.

Usage Pool attachment with node referenced from f5bigip.ltm.Node

Create PoolAttachment Resource

Constructor syntax

Parameters

Constructor example

PoolAttachment Resource Properties

Inputs

Outputs

Look up Existing PoolAttachment Resource

Import

Package Details

On this page

On this page

Usage Pool attachment with node referenced from `f5bigip.ltm.Node`