Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. LbPool
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.LbPool

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

Create LbPool Resource

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

Constructor syntax

new LbPool(name: string, args?: LbPoolArgs, opts?: CustomResourceOptions);
@overload
def LbPool(resource_name: str,
           args: Optional[LbPoolArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def LbPool(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           active_monitor_id: Optional[str] = None,
           algorithm: Optional[str] = None,
           description: Optional[str] = None,
           display_name: Optional[str] = None,
           lb_pool_id: Optional[str] = None,
           member_group: Optional[LbPoolMemberGroupArgs] = None,
           members: Optional[Sequence[LbPoolMemberArgs]] = None,
           min_active_members: Optional[float] = None,
           passive_monitor_id: Optional[str] = None,
           snat_translation: Optional[LbPoolSnatTranslationArgs] = None,
           tags: Optional[Sequence[LbPoolTagArgs]] = None,
           tcp_multiplexing_enabled: Optional[bool] = None,
           tcp_multiplexing_number: Optional[float] = None)
func NewLbPool(ctx *Context, name string, args *LbPoolArgs, opts ...ResourceOption) (*LbPool, error)
public LbPool(string name, LbPoolArgs? args = null, CustomResourceOptions? opts = null)
public LbPool(String name, LbPoolArgs args)
public LbPool(String name, LbPoolArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args LbPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args LbPoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args LbPoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args LbPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LbPoolArgs
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.

var lbPoolResource = new Nsxt.LbPool("lbPoolResource", new()
{
    ActiveMonitorId = "string",
    Algorithm = "string",
    Description = "string",
    DisplayName = "string",
    LbPoolId = "string",
    MemberGroup = new Nsxt.Inputs.LbPoolMemberGroupArgs
    {
        GroupingObject = new Nsxt.Inputs.LbPoolMemberGroupGroupingObjectArgs
        {
            IsValid = false,
            TargetDisplayName = "string",
            TargetId = "string",
            TargetType = "string",
        },
        IpVersionFilter = "string",
        LimitIpListSize = false,
        MaxIpListSize = 0,
        Port = 0,
    },
    Members = new[]
    {
        new Nsxt.Inputs.LbPoolMemberArgs
        {
            IpAddress = "string",
            AdminState = "string",
            BackupMember = false,
            DisplayName = "string",
            MaxConcurrentConnections = 0,
            Port = "string",
            Weight = 0,
        },
    },
    MinActiveMembers = 0,
    PassiveMonitorId = "string",
    SnatTranslation = new Nsxt.Inputs.LbPoolSnatTranslationArgs
    {
        Ip = "string",
        Type = "string",
    },
    Tags = new[]
    {
        new Nsxt.Inputs.LbPoolTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    TcpMultiplexingEnabled = false,
    TcpMultiplexingNumber = 0,
});
Copy
example, err := nsxt.NewLbPool(ctx, "lbPoolResource", &nsxt.LbPoolArgs{
ActiveMonitorId: pulumi.String("string"),
Algorithm: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
LbPoolId: pulumi.String("string"),
MemberGroup: &.LbPoolMemberGroupArgs{
GroupingObject: &.LbPoolMemberGroupGroupingObjectArgs{
IsValid: pulumi.Bool(false),
TargetDisplayName: pulumi.String("string"),
TargetId: pulumi.String("string"),
TargetType: pulumi.String("string"),
},
IpVersionFilter: pulumi.String("string"),
LimitIpListSize: pulumi.Bool(false),
MaxIpListSize: pulumi.Float64(0),
Port: pulumi.Float64(0),
},
Members: .LbPoolMemberArray{
&.LbPoolMemberArgs{
IpAddress: pulumi.String("string"),
AdminState: pulumi.String("string"),
BackupMember: pulumi.Bool(false),
DisplayName: pulumi.String("string"),
MaxConcurrentConnections: pulumi.Float64(0),
Port: pulumi.String("string"),
Weight: pulumi.Float64(0),
},
},
MinActiveMembers: pulumi.Float64(0),
PassiveMonitorId: pulumi.String("string"),
SnatTranslation: &.LbPoolSnatTranslationArgs{
Ip: pulumi.String("string"),
Type: pulumi.String("string"),
},
Tags: .LbPoolTagArray{
&.LbPoolTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
TcpMultiplexingEnabled: pulumi.Bool(false),
TcpMultiplexingNumber: pulumi.Float64(0),
})
Copy
var lbPoolResource = new LbPool("lbPoolResource", LbPoolArgs.builder()
    .activeMonitorId("string")
    .algorithm("string")
    .description("string")
    .displayName("string")
    .lbPoolId("string")
    .memberGroup(LbPoolMemberGroupArgs.builder()
        .groupingObject(LbPoolMemberGroupGroupingObjectArgs.builder()
            .isValid(false)
            .targetDisplayName("string")
            .targetId("string")
            .targetType("string")
            .build())
        .ipVersionFilter("string")
        .limitIpListSize(false)
        .maxIpListSize(0)
        .port(0)
        .build())
    .members(LbPoolMemberArgs.builder()
        .ipAddress("string")
        .adminState("string")
        .backupMember(false)
        .displayName("string")
        .maxConcurrentConnections(0)
        .port("string")
        .weight(0)
        .build())
    .minActiveMembers(0)
    .passiveMonitorId("string")
    .snatTranslation(LbPoolSnatTranslationArgs.builder()
        .ip("string")
        .type("string")
        .build())
    .tags(LbPoolTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .tcpMultiplexingEnabled(false)
    .tcpMultiplexingNumber(0)
    .build());
Copy
lb_pool_resource = nsxt.LbPool("lbPoolResource",
    active_monitor_id="string",
    algorithm="string",
    description="string",
    display_name="string",
    lb_pool_id="string",
    member_group={
        "grouping_object": {
            "is_valid": False,
            "target_display_name": "string",
            "target_id": "string",
            "target_type": "string",
        },
        "ip_version_filter": "string",
        "limit_ip_list_size": False,
        "max_ip_list_size": 0,
        "port": 0,
    },
    members=[{
        "ip_address": "string",
        "admin_state": "string",
        "backup_member": False,
        "display_name": "string",
        "max_concurrent_connections": 0,
        "port": "string",
        "weight": 0,
    }],
    min_active_members=0,
    passive_monitor_id="string",
    snat_translation={
        "ip": "string",
        "type": "string",
    },
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    tcp_multiplexing_enabled=False,
    tcp_multiplexing_number=0)
Copy
const lbPoolResource = new nsxt.LbPool("lbPoolResource", {
    activeMonitorId: "string",
    algorithm: "string",
    description: "string",
    displayName: "string",
    lbPoolId: "string",
    memberGroup: {
        groupingObject: {
            isValid: false,
            targetDisplayName: "string",
            targetId: "string",
            targetType: "string",
        },
        ipVersionFilter: "string",
        limitIpListSize: false,
        maxIpListSize: 0,
        port: 0,
    },
    members: [{
        ipAddress: "string",
        adminState: "string",
        backupMember: false,
        displayName: "string",
        maxConcurrentConnections: 0,
        port: "string",
        weight: 0,
    }],
    minActiveMembers: 0,
    passiveMonitorId: "string",
    snatTranslation: {
        ip: "string",
        type: "string",
    },
    tags: [{
        scope: "string",
        tag: "string",
    }],
    tcpMultiplexingEnabled: false,
    tcpMultiplexingNumber: 0,
});
Copy
type: nsxt:LbPool
properties:
    activeMonitorId: string
    algorithm: string
    description: string
    displayName: string
    lbPoolId: string
    memberGroup:
        groupingObject:
            isValid: false
            targetDisplayName: string
            targetId: string
            targetType: string
        ipVersionFilter: string
        limitIpListSize: false
        maxIpListSize: 0
        port: 0
    members:
        - adminState: string
          backupMember: false
          displayName: string
          ipAddress: string
          maxConcurrentConnections: 0
          port: string
          weight: 0
    minActiveMembers: 0
    passiveMonitorId: string
    snatTranslation:
        ip: string
        type: string
    tags:
        - scope: string
          tag: string
    tcpMultiplexingEnabled: false
    tcpMultiplexingNumber: 0
Copy

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

ActiveMonitorId string
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
Algorithm string
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
Description string
Description of this resource.
DisplayName string
The display name of this resource. Defaults to ID if not set.
LbPoolId string
ID of the lb pool.
MemberGroup LbPoolMemberGroup
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
Members List<LbPoolMember>
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
MinActiveMembers double
The minimum number of members for the pool to be considered active. This value is 1 by default.
PassiveMonitorId string
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
SnatTranslation LbPoolSnatTranslation
SNAT translation configuration
Tags List<LbPoolTag>
A list of scope + tag pairs to associate with this lb pool.
TcpMultiplexingEnabled bool
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
TcpMultiplexingNumber double
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
ActiveMonitorId string
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
Algorithm string
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
Description string
Description of this resource.
DisplayName string
The display name of this resource. Defaults to ID if not set.
LbPoolId string
ID of the lb pool.
MemberGroup LbPoolMemberGroupArgs
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
Members []LbPoolMemberArgs
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
MinActiveMembers float64
The minimum number of members for the pool to be considered active. This value is 1 by default.
PassiveMonitorId string
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
SnatTranslation LbPoolSnatTranslationArgs
SNAT translation configuration
Tags []LbPoolTagArgs
A list of scope + tag pairs to associate with this lb pool.
TcpMultiplexingEnabled bool
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
TcpMultiplexingNumber float64
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
activeMonitorId String
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
algorithm String
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
description String
Description of this resource.
displayName String
The display name of this resource. Defaults to ID if not set.
lbPoolId String
ID of the lb pool.
memberGroup LbPoolMemberGroup
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
members List<LbPoolMember>
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
minActiveMembers Double
The minimum number of members for the pool to be considered active. This value is 1 by default.
passiveMonitorId String
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
snatTranslation LbPoolSnatTranslation
SNAT translation configuration
tags List<LbPoolTag>
A list of scope + tag pairs to associate with this lb pool.
tcpMultiplexingEnabled Boolean
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
tcpMultiplexingNumber Double
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
activeMonitorId string
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
algorithm string
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
description string
Description of this resource.
displayName string
The display name of this resource. Defaults to ID if not set.
lbPoolId string
ID of the lb pool.
memberGroup LbPoolMemberGroup
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
members LbPoolMember[]
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
minActiveMembers number
The minimum number of members for the pool to be considered active. This value is 1 by default.
passiveMonitorId string
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
snatTranslation LbPoolSnatTranslation
SNAT translation configuration
tags LbPoolTag[]
A list of scope + tag pairs to associate with this lb pool.
tcpMultiplexingEnabled boolean
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
tcpMultiplexingNumber number
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
active_monitor_id str
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
algorithm str
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
description str
Description of this resource.
display_name str
The display name of this resource. Defaults to ID if not set.
lb_pool_id str
ID of the lb pool.
member_group LbPoolMemberGroupArgs
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
members Sequence[LbPoolMemberArgs]
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
min_active_members float
The minimum number of members for the pool to be considered active. This value is 1 by default.
passive_monitor_id str
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
snat_translation LbPoolSnatTranslationArgs
SNAT translation configuration
tags Sequence[LbPoolTagArgs]
A list of scope + tag pairs to associate with this lb pool.
tcp_multiplexing_enabled bool
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
tcp_multiplexing_number float
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
activeMonitorId String
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
algorithm String
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
description String
Description of this resource.
displayName String
The display name of this resource. Defaults to ID if not set.
lbPoolId String
ID of the lb pool.
memberGroup Property Map
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
members List<Property Map>
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
minActiveMembers Number
The minimum number of members for the pool to be considered active. This value is 1 by default.
passiveMonitorId String
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
snatTranslation Property Map
SNAT translation configuration
tags List<Property Map>
A list of scope + tag pairs to associate with this lb pool.
tcpMultiplexingEnabled Boolean
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
tcpMultiplexingNumber Number
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.

Outputs

All input properties are implicitly available as output properties. Additionally, the LbPool resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Id string
The provider-assigned unique ID for this managed resource.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id string
The provider-assigned unique ID for this managed resource.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id str
The provider-assigned unique ID for this managed resource.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

Look up Existing LbPool Resource

Get an existing LbPool 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?: LbPoolState, opts?: CustomResourceOptions): LbPool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_monitor_id: Optional[str] = None,
        algorithm: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        lb_pool_id: Optional[str] = None,
        member_group: Optional[LbPoolMemberGroupArgs] = None,
        members: Optional[Sequence[LbPoolMemberArgs]] = None,
        min_active_members: Optional[float] = None,
        passive_monitor_id: Optional[str] = None,
        revision: Optional[float] = None,
        snat_translation: Optional[LbPoolSnatTranslationArgs] = None,
        tags: Optional[Sequence[LbPoolTagArgs]] = None,
        tcp_multiplexing_enabled: Optional[bool] = None,
        tcp_multiplexing_number: Optional[float] = None) -> LbPool
func GetLbPool(ctx *Context, name string, id IDInput, state *LbPoolState, opts ...ResourceOption) (*LbPool, error)
public static LbPool Get(string name, Input<string> id, LbPoolState? state, CustomResourceOptions? opts = null)
public static LbPool get(String name, Output<String> id, LbPoolState state, CustomResourceOptions options)
resources:  _:    type: nsxt:LbPool    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ActiveMonitorId string
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
Algorithm string
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
Description string
Description of this resource.
DisplayName string
The display name of this resource. Defaults to ID if not set.
LbPoolId string
ID of the lb pool.
MemberGroup LbPoolMemberGroup
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
Members List<LbPoolMember>
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
MinActiveMembers double
The minimum number of members for the pool to be considered active. This value is 1 by default.
PassiveMonitorId string
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
SnatTranslation LbPoolSnatTranslation
SNAT translation configuration
Tags List<LbPoolTag>
A list of scope + tag pairs to associate with this lb pool.
TcpMultiplexingEnabled bool
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
TcpMultiplexingNumber double
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
ActiveMonitorId string
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
Algorithm string
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
Description string
Description of this resource.
DisplayName string
The display name of this resource. Defaults to ID if not set.
LbPoolId string
ID of the lb pool.
MemberGroup LbPoolMemberGroupArgs
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
Members []LbPoolMemberArgs
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
MinActiveMembers float64
The minimum number of members for the pool to be considered active. This value is 1 by default.
PassiveMonitorId string
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
SnatTranslation LbPoolSnatTranslationArgs
SNAT translation configuration
Tags []LbPoolTagArgs
A list of scope + tag pairs to associate with this lb pool.
TcpMultiplexingEnabled bool
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
TcpMultiplexingNumber float64
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
activeMonitorId String
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
algorithm String
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
description String
Description of this resource.
displayName String
The display name of this resource. Defaults to ID if not set.
lbPoolId String
ID of the lb pool.
memberGroup LbPoolMemberGroup
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
members List<LbPoolMember>
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
minActiveMembers Double
The minimum number of members for the pool to be considered active. This value is 1 by default.
passiveMonitorId String
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
snatTranslation LbPoolSnatTranslation
SNAT translation configuration
tags List<LbPoolTag>
A list of scope + tag pairs to associate with this lb pool.
tcpMultiplexingEnabled Boolean
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
tcpMultiplexingNumber Double
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
activeMonitorId string
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
algorithm string
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
description string
Description of this resource.
displayName string
The display name of this resource. Defaults to ID if not set.
lbPoolId string
ID of the lb pool.
memberGroup LbPoolMemberGroup
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
members LbPoolMember[]
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
minActiveMembers number
The minimum number of members for the pool to be considered active. This value is 1 by default.
passiveMonitorId string
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
snatTranslation LbPoolSnatTranslation
SNAT translation configuration
tags LbPoolTag[]
A list of scope + tag pairs to associate with this lb pool.
tcpMultiplexingEnabled boolean
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
tcpMultiplexingNumber number
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
active_monitor_id str
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
algorithm str
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
description str
Description of this resource.
display_name str
The display name of this resource. Defaults to ID if not set.
lb_pool_id str
ID of the lb pool.
member_group LbPoolMemberGroupArgs
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
members Sequence[LbPoolMemberArgs]
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
min_active_members float
The minimum number of members for the pool to be considered active. This value is 1 by default.
passive_monitor_id str
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
snat_translation LbPoolSnatTranslationArgs
SNAT translation configuration
tags Sequence[LbPoolTagArgs]
A list of scope + tag pairs to associate with this lb pool.
tcp_multiplexing_enabled bool
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
tcp_multiplexing_number float
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.
activeMonitorId String
Active health monitor Id. If one is not set, the active healthchecks will be disabled.
algorithm String
Load balancing algorithm controls how the incoming connections are distributed among the members. Supported algorithms are: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH.
description String
Description of this resource.
displayName String
The display name of this resource. Defaults to ID if not set.
lbPoolId String
ID of the lb pool.
memberGroup Property Map
Dynamic pool members for the loadbalancing pool. When member group is defined, members setting should not be specified. The member_group has the following arguments:
members List<Property Map>
Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. Each member has the following arguments:
minActiveMembers Number
The minimum number of members for the pool to be considered active. This value is 1 by default.
passiveMonitorId String
Passive health monitor Id. If one is not set, the passive healthchecks will be disabled.

  • `snat_translation - (Optional) SNAT translation configuration for the pool.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
snatTranslation Property Map
SNAT translation configuration
tags List<Property Map>
A list of scope + tag pairs to associate with this lb pool.
tcpMultiplexingEnabled Boolean
TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. Disabled by default.
tcpMultiplexingNumber Number
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. The default value for this is 6.

Supporting Types

LbPoolMember
, LbPoolMemberArgs

IpAddress This property is required. string
Pool member IP address.
AdminState string
Pool member admin state. Possible values: ENABLED, DISABLED and GRACEFUL_DISABLED
BackupMember bool
A boolean flag which reflects whether this is a backup pool member. Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).
DisplayName string
The display name of this resource. pool member name.
MaxConcurrentConnections double
To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited.
Port string
If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case.
Weight double
Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms.
IpAddress This property is required. string
Pool member IP address.
AdminState string
Pool member admin state. Possible values: ENABLED, DISABLED and GRACEFUL_DISABLED
BackupMember bool
A boolean flag which reflects whether this is a backup pool member. Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).
DisplayName string
The display name of this resource. pool member name.
MaxConcurrentConnections float64
To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited.
Port string
If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case.
Weight float64
Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms.
ipAddress This property is required. String
Pool member IP address.
adminState String
Pool member admin state. Possible values: ENABLED, DISABLED and GRACEFUL_DISABLED
backupMember Boolean
A boolean flag which reflects whether this is a backup pool member. Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).
displayName String
The display name of this resource. pool member name.
maxConcurrentConnections Double
To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited.
port String
If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case.
weight Double
Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms.
ipAddress This property is required. string
Pool member IP address.
adminState string
Pool member admin state. Possible values: ENABLED, DISABLED and GRACEFUL_DISABLED
backupMember boolean
A boolean flag which reflects whether this is a backup pool member. Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).
displayName string
The display name of this resource. pool member name.
maxConcurrentConnections number
To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited.
port string
If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case.
weight number
Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms.
ip_address This property is required. str
Pool member IP address.
admin_state str
Pool member admin state. Possible values: ENABLED, DISABLED and GRACEFUL_DISABLED
backup_member bool
A boolean flag which reflects whether this is a backup pool member. Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).
display_name str
The display name of this resource. pool member name.
max_concurrent_connections float
To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited.
port str
If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case.
weight float
Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms.
ipAddress This property is required. String
Pool member IP address.
adminState String
Pool member admin state. Possible values: ENABLED, DISABLED and GRACEFUL_DISABLED
backupMember Boolean
A boolean flag which reflects whether this is a backup pool member. Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).
displayName String
The display name of this resource. pool member name.
maxConcurrentConnections Number
To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited.
port String
If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case.
weight Number
Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms.

LbPoolMemberGroup
, LbPoolMemberGroupArgs

GroupingObject This property is required. LbPoolMemberGroupGroupingObject
Grouping object of type NSGroup which will be used as dynamic pool members. The IP list of the grouping object would be used as pool member IP setting.
IpVersionFilter string
Ip version filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. Supported filtering is "IPV4" and "IPV6" ("IPV4" is the default one)
LimitIpListSize bool
Limits the max number of pool members. If false, allows the dynamic pool to grow up to the load balancer max pool member capacity.
MaxIpListSize double
Should only be specified if limit_ip_list_size is set to true. Limits the max number of pool members to the specified value.
Port double
If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case.
GroupingObject This property is required. LbPoolMemberGroupGroupingObject
Grouping object of type NSGroup which will be used as dynamic pool members. The IP list of the grouping object would be used as pool member IP setting.
IpVersionFilter string
Ip version filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. Supported filtering is "IPV4" and "IPV6" ("IPV4" is the default one)
LimitIpListSize bool
Limits the max number of pool members. If false, allows the dynamic pool to grow up to the load balancer max pool member capacity.
MaxIpListSize float64
Should only be specified if limit_ip_list_size is set to true. Limits the max number of pool members to the specified value.
Port float64
If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case.
groupingObject This property is required. LbPoolMemberGroupGroupingObject
Grouping object of type NSGroup which will be used as dynamic pool members. The IP list of the grouping object would be used as pool member IP setting.
ipVersionFilter String
Ip version filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. Supported filtering is "IPV4" and "IPV6" ("IPV4" is the default one)
limitIpListSize Boolean
Limits the max number of pool members. If false, allows the dynamic pool to grow up to the load balancer max pool member capacity.
maxIpListSize Double
Should only be specified if limit_ip_list_size is set to true. Limits the max number of pool members to the specified value.
port Double
If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case.
groupingObject This property is required. LbPoolMemberGroupGroupingObject
Grouping object of type NSGroup which will be used as dynamic pool members. The IP list of the grouping object would be used as pool member IP setting.
ipVersionFilter string
Ip version filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. Supported filtering is "IPV4" and "IPV6" ("IPV4" is the default one)
limitIpListSize boolean
Limits the max number of pool members. If false, allows the dynamic pool to grow up to the load balancer max pool member capacity.
maxIpListSize number
Should only be specified if limit_ip_list_size is set to true. Limits the max number of pool members to the specified value.
port number
If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case.
grouping_object This property is required. LbPoolMemberGroupGroupingObject
Grouping object of type NSGroup which will be used as dynamic pool members. The IP list of the grouping object would be used as pool member IP setting.
ip_version_filter str
Ip version filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. Supported filtering is "IPV4" and "IPV6" ("IPV4" is the default one)
limit_ip_list_size bool
Limits the max number of pool members. If false, allows the dynamic pool to grow up to the load balancer max pool member capacity.
max_ip_list_size float
Should only be specified if limit_ip_list_size is set to true. Limits the max number of pool members to the specified value.
port float
If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case.
groupingObject This property is required. Property Map
Grouping object of type NSGroup which will be used as dynamic pool members. The IP list of the grouping object would be used as pool member IP setting.
ipVersionFilter String
Ip version filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. Supported filtering is "IPV4" and "IPV6" ("IPV4" is the default one)
limitIpListSize Boolean
Limits the max number of pool members. If false, allows the dynamic pool to grow up to the load balancer max pool member capacity.
maxIpListSize Number
Should only be specified if limit_ip_list_size is set to true. Limits the max number of pool members to the specified value.
port Number
If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case.

LbPoolMemberGroupGroupingObject
, LbPoolMemberGroupGroupingObjectArgs

IsValid bool
A boolean flag which will be set to false if the referenced NSX resource has been deleted
TargetDisplayName string
Display name of the NSX resource
TargetId string
Identifier of the NSX resource
TargetType string
Type of the NSX resource
IsValid bool
A boolean flag which will be set to false if the referenced NSX resource has been deleted
TargetDisplayName string
Display name of the NSX resource
TargetId string
Identifier of the NSX resource
TargetType string
Type of the NSX resource
isValid Boolean
A boolean flag which will be set to false if the referenced NSX resource has been deleted
targetDisplayName String
Display name of the NSX resource
targetId String
Identifier of the NSX resource
targetType String
Type of the NSX resource
isValid boolean
A boolean flag which will be set to false if the referenced NSX resource has been deleted
targetDisplayName string
Display name of the NSX resource
targetId string
Identifier of the NSX resource
targetType string
Type of the NSX resource
is_valid bool
A boolean flag which will be set to false if the referenced NSX resource has been deleted
target_display_name str
Display name of the NSX resource
target_id str
Identifier of the NSX resource
target_type str
Type of the NSX resource
isValid Boolean
A boolean flag which will be set to false if the referenced NSX resource has been deleted
targetDisplayName String
Display name of the NSX resource
targetId String
Identifier of the NSX resource
targetType String
Type of the NSX resource

LbPoolSnatTranslation
, LbPoolSnatTranslationArgs

Ip string
Ip address or Ip range for SNAT of type SNAT_IP_POOL
Type string
Type of SNAT performed to ensure reverse traffic from the server can be received and processed by the loadbalancer
Ip string
Ip address or Ip range for SNAT of type SNAT_IP_POOL
Type string
Type of SNAT performed to ensure reverse traffic from the server can be received and processed by the loadbalancer
ip String
Ip address or Ip range for SNAT of type SNAT_IP_POOL
type String
Type of SNAT performed to ensure reverse traffic from the server can be received and processed by the loadbalancer
ip string
Ip address or Ip range for SNAT of type SNAT_IP_POOL
type string
Type of SNAT performed to ensure reverse traffic from the server can be received and processed by the loadbalancer
ip str
Ip address or Ip range for SNAT of type SNAT_IP_POOL
type str
Type of SNAT performed to ensure reverse traffic from the server can be received and processed by the loadbalancer
ip String
Ip address or Ip range for SNAT of type SNAT_IP_POOL
type String
Type of SNAT performed to ensure reverse traffic from the server can be received and processed by the loadbalancer

LbPoolTag
, LbPoolTagArgs

Scope string
Tag string
A list of scope + tag pairs to associate with this lb pool.
Scope string
Tag string
A list of scope + tag pairs to associate with this lb pool.
scope String
tag String
A list of scope + tag pairs to associate with this lb pool.
scope string
tag string
A list of scope + tag pairs to associate with this lb pool.
scope str
tag str
A list of scope + tag pairs to associate with this lb pool.
scope String
tag String
A list of scope + tag pairs to associate with this lb pool.

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt