1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyLbPool
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.PolicyLbPool

Explore with Pulumi AI

Create PolicyLbPool Resource

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

Constructor syntax

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

@overload
def PolicyLbPool(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 display_name: Optional[str] = None,
                 members: Optional[Sequence[PolicyLbPoolMemberArgs]] = None,
                 nsx_id: Optional[str] = None,
                 description: Optional[str] = None,
                 active_monitor_paths: Optional[Sequence[str]] = None,
                 member_group: Optional[PolicyLbPoolMemberGroupArgs] = None,
                 active_monitor_path: Optional[str] = None,
                 min_active_members: Optional[float] = None,
                 algorithm: Optional[str] = None,
                 passive_monitor_path: Optional[str] = None,
                 policy_lb_pool_id: Optional[str] = None,
                 snat: Optional[PolicyLbPoolSnatArgs] = None,
                 tags: Optional[Sequence[PolicyLbPoolTagArgs]] = None,
                 tcp_multiplexing_enabled: Optional[bool] = None,
                 tcp_multiplexing_number: Optional[float] = None)
func NewPolicyLbPool(ctx *Context, name string, args PolicyLbPoolArgs, opts ...ResourceOption) (*PolicyLbPool, error)
public PolicyLbPool(string name, PolicyLbPoolArgs args, CustomResourceOptions? opts = null)
public PolicyLbPool(String name, PolicyLbPoolArgs args)
public PolicyLbPool(String name, PolicyLbPoolArgs args, CustomResourceOptions options)
type: nsxt:PolicyLbPool
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 This property is required. PolicyLbPoolArgs
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 This property is required. PolicyLbPoolArgs
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 This property is required. PolicyLbPoolArgs
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 This property is required. PolicyLbPoolArgs
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. PolicyLbPoolArgs
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 policyLbPoolResource = new Nsxt.PolicyLbPool("policyLbPoolResource", new()
{
    DisplayName = "string",
    Members = new[]
    {
        new Nsxt.Inputs.PolicyLbPoolMemberArgs
        {
            IpAddress = "string",
            AdminState = "string",
            BackupMember = false,
            DisplayName = "string",
            MaxConcurrentConnections = 0,
            Port = "string",
            Weight = 0,
        },
    },
    NsxId = "string",
    Description = "string",
    ActiveMonitorPaths = new[]
    {
        "string",
    },
    MemberGroup = new Nsxt.Inputs.PolicyLbPoolMemberGroupArgs
    {
        GroupPath = "string",
        AllowIpv4 = false,
        AllowIpv6 = false,
        MaxIpListSize = 0,
        Port = "string",
    },
    MinActiveMembers = 0,
    Algorithm = "string",
    PassiveMonitorPath = "string",
    PolicyLbPoolId = "string",
    Snat = new Nsxt.Inputs.PolicyLbPoolSnatArgs
    {
        IpPoolAddresses = new[]
        {
            "string",
        },
        Type = "string",
    },
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyLbPoolTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    TcpMultiplexingEnabled = false,
    TcpMultiplexingNumber = 0,
});
Copy
example, err := nsxt.NewPolicyLbPool(ctx, "policyLbPoolResource", &nsxt.PolicyLbPoolArgs{
DisplayName: pulumi.String("string"),
Members: .PolicyLbPoolMemberArray{
&.PolicyLbPoolMemberArgs{
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),
},
},
NsxId: pulumi.String("string"),
Description: pulumi.String("string"),
ActiveMonitorPaths: pulumi.StringArray{
pulumi.String("string"),
},
MemberGroup: &.PolicyLbPoolMemberGroupArgs{
GroupPath: pulumi.String("string"),
AllowIpv4: pulumi.Bool(false),
AllowIpv6: pulumi.Bool(false),
MaxIpListSize: pulumi.Float64(0),
Port: pulumi.String("string"),
},
MinActiveMembers: pulumi.Float64(0),
Algorithm: pulumi.String("string"),
PassiveMonitorPath: pulumi.String("string"),
PolicyLbPoolId: pulumi.String("string"),
Snat: &.PolicyLbPoolSnatArgs{
IpPoolAddresses: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
},
Tags: .PolicyLbPoolTagArray{
&.PolicyLbPoolTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
TcpMultiplexingEnabled: pulumi.Bool(false),
TcpMultiplexingNumber: pulumi.Float64(0),
})
Copy
var policyLbPoolResource = new PolicyLbPool("policyLbPoolResource", PolicyLbPoolArgs.builder()
    .displayName("string")
    .members(PolicyLbPoolMemberArgs.builder()
        .ipAddress("string")
        .adminState("string")
        .backupMember(false)
        .displayName("string")
        .maxConcurrentConnections(0)
        .port("string")
        .weight(0)
        .build())
    .nsxId("string")
    .description("string")
    .activeMonitorPaths("string")
    .memberGroup(PolicyLbPoolMemberGroupArgs.builder()
        .groupPath("string")
        .allowIpv4(false)
        .allowIpv6(false)
        .maxIpListSize(0)
        .port("string")
        .build())
    .minActiveMembers(0)
    .algorithm("string")
    .passiveMonitorPath("string")
    .policyLbPoolId("string")
    .snat(PolicyLbPoolSnatArgs.builder()
        .ipPoolAddresses("string")
        .type("string")
        .build())
    .tags(PolicyLbPoolTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .tcpMultiplexingEnabled(false)
    .tcpMultiplexingNumber(0)
    .build());
Copy
policy_lb_pool_resource = nsxt.PolicyLbPool("policyLbPoolResource",
    display_name="string",
    members=[{
        "ip_address": "string",
        "admin_state": "string",
        "backup_member": False,
        "display_name": "string",
        "max_concurrent_connections": 0,
        "port": "string",
        "weight": 0,
    }],
    nsx_id="string",
    description="string",
    active_monitor_paths=["string"],
    member_group={
        "group_path": "string",
        "allow_ipv4": False,
        "allow_ipv6": False,
        "max_ip_list_size": 0,
        "port": "string",
    },
    min_active_members=0,
    algorithm="string",
    passive_monitor_path="string",
    policy_lb_pool_id="string",
    snat={
        "ip_pool_addresses": ["string"],
        "type": "string",
    },
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    tcp_multiplexing_enabled=False,
    tcp_multiplexing_number=0)
Copy
const policyLbPoolResource = new nsxt.PolicyLbPool("policyLbPoolResource", {
    displayName: "string",
    members: [{
        ipAddress: "string",
        adminState: "string",
        backupMember: false,
        displayName: "string",
        maxConcurrentConnections: 0,
        port: "string",
        weight: 0,
    }],
    nsxId: "string",
    description: "string",
    activeMonitorPaths: ["string"],
    memberGroup: {
        groupPath: "string",
        allowIpv4: false,
        allowIpv6: false,
        maxIpListSize: 0,
        port: "string",
    },
    minActiveMembers: 0,
    algorithm: "string",
    passiveMonitorPath: "string",
    policyLbPoolId: "string",
    snat: {
        ipPoolAddresses: ["string"],
        type: "string",
    },
    tags: [{
        scope: "string",
        tag: "string",
    }],
    tcpMultiplexingEnabled: false,
    tcpMultiplexingNumber: 0,
});
Copy
type: nsxt:PolicyLbPool
properties:
    activeMonitorPaths:
        - string
    algorithm: string
    description: string
    displayName: string
    memberGroup:
        allowIpv4: false
        allowIpv6: false
        groupPath: string
        maxIpListSize: 0
        port: string
    members:
        - adminState: string
          backupMember: false
          displayName: string
          ipAddress: string
          maxConcurrentConnections: 0
          port: string
          weight: 0
    minActiveMembers: 0
    nsxId: string
    passiveMonitorPath: string
    policyLbPoolId: string
    snat:
        ipPoolAddresses:
            - string
        type: string
    tags:
        - scope: string
          tag: string
    tcpMultiplexingEnabled: false
    tcpMultiplexingNumber: 0
Copy

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

DisplayName This property is required. string
Display name of the resource.
ActiveMonitorPath string
Active monitor to be associated with this pool.

Deprecated: Deprecated

ActiveMonitorPaths List<string>
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
Algorithm string
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
Description string
Description of the resource.
MemberGroup PolicyLbPoolMemberGroup
Grouping specification for pool members. When member_group is set, member should not be specified.
Members List<PolicyLbPoolMember>
Members of the pool. When member' is set, member_group` should not be specified.
MinActiveMembers double
A pool is considered active if there are at least certain minimum number of members.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PassiveMonitorPath string
Passive monitor to be associated with this pool.
PolicyLbPoolId string
ID of the Security Policy.
Snat PolicyLbPoolSnat
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
Tags List<PolicyLbPoolTag>
A list of scope + tag pairs to associate with this resource.
TcpMultiplexingEnabled bool
Enable TCP multiplexing within the pool.
TcpMultiplexingNumber double
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
DisplayName This property is required. string
Display name of the resource.
ActiveMonitorPath string
Active monitor to be associated with this pool.

Deprecated: Deprecated

ActiveMonitorPaths []string
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
Algorithm string
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
Description string
Description of the resource.
MemberGroup PolicyLbPoolMemberGroupArgs
Grouping specification for pool members. When member_group is set, member should not be specified.
Members []PolicyLbPoolMemberArgs
Members of the pool. When member' is set, member_group` should not be specified.
MinActiveMembers float64
A pool is considered active if there are at least certain minimum number of members.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PassiveMonitorPath string
Passive monitor to be associated with this pool.
PolicyLbPoolId string
ID of the Security Policy.
Snat PolicyLbPoolSnatArgs
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
Tags []PolicyLbPoolTagArgs
A list of scope + tag pairs to associate with this resource.
TcpMultiplexingEnabled bool
Enable TCP multiplexing within the pool.
TcpMultiplexingNumber float64
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
displayName This property is required. String
Display name of the resource.
activeMonitorPath String
Active monitor to be associated with this pool.

Deprecated: Deprecated

activeMonitorPaths List<String>
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
algorithm String
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
description String
Description of the resource.
memberGroup PolicyLbPoolMemberGroup
Grouping specification for pool members. When member_group is set, member should not be specified.
members List<PolicyLbPoolMember>
Members of the pool. When member' is set, member_group` should not be specified.
minActiveMembers Double
A pool is considered active if there are at least certain minimum number of members.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
passiveMonitorPath String
Passive monitor to be associated with this pool.
policyLbPoolId String
ID of the Security Policy.
snat PolicyLbPoolSnat
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
tags List<PolicyLbPoolTag>
A list of scope + tag pairs to associate with this resource.
tcpMultiplexingEnabled Boolean
Enable TCP multiplexing within the pool.
tcpMultiplexingNumber Double
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
displayName This property is required. string
Display name of the resource.
activeMonitorPath string
Active monitor to be associated with this pool.

Deprecated: Deprecated

activeMonitorPaths string[]
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
algorithm string
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
description string
Description of the resource.
memberGroup PolicyLbPoolMemberGroup
Grouping specification for pool members. When member_group is set, member should not be specified.
members PolicyLbPoolMember[]
Members of the pool. When member' is set, member_group` should not be specified.
minActiveMembers number
A pool is considered active if there are at least certain minimum number of members.
nsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
passiveMonitorPath string
Passive monitor to be associated with this pool.
policyLbPoolId string
ID of the Security Policy.
snat PolicyLbPoolSnat
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
tags PolicyLbPoolTag[]
A list of scope + tag pairs to associate with this resource.
tcpMultiplexingEnabled boolean
Enable TCP multiplexing within the pool.
tcpMultiplexingNumber number
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
display_name This property is required. str
Display name of the resource.
active_monitor_path str
Active monitor to be associated with this pool.

Deprecated: Deprecated

active_monitor_paths Sequence[str]
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
algorithm str
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
description str
Description of the resource.
member_group PolicyLbPoolMemberGroupArgs
Grouping specification for pool members. When member_group is set, member should not be specified.
members Sequence[PolicyLbPoolMemberArgs]
Members of the pool. When member' is set, member_group` should not be specified.
min_active_members float
A pool is considered active if there are at least certain minimum number of members.
nsx_id str
The NSX ID of this resource. If set, this ID will be used to create the resource.
passive_monitor_path str
Passive monitor to be associated with this pool.
policy_lb_pool_id str
ID of the Security Policy.
snat PolicyLbPoolSnatArgs
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
tags Sequence[PolicyLbPoolTagArgs]
A list of scope + tag pairs to associate with this resource.
tcp_multiplexing_enabled bool
Enable TCP multiplexing within the pool.
tcp_multiplexing_number float
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
displayName This property is required. String
Display name of the resource.
activeMonitorPath String
Active monitor to be associated with this pool.

Deprecated: Deprecated

activeMonitorPaths List<String>
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
algorithm String
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
description String
Description of the resource.
memberGroup Property Map
Grouping specification for pool members. When member_group is set, member should not be specified.
members List<Property Map>
Members of the pool. When member' is set, member_group` should not be specified.
minActiveMembers Number
A pool is considered active if there are at least certain minimum number of members.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
passiveMonitorPath String
Passive monitor to be associated with this pool.
policyLbPoolId String
ID of the Security Policy.
snat Property Map
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.
tcpMultiplexingEnabled Boolean
Enable TCP multiplexing within the pool.
tcpMultiplexingNumber Number
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Path string
The NSX path of the policy 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.
Path string
The NSX path of the policy 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.
path String
The NSX path of the policy 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.
path string
The NSX path of the policy 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.
path str
The NSX path of the policy 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.
path String
The NSX path of the policy 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 PolicyLbPool Resource

Get an existing PolicyLbPool 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?: PolicyLbPoolState, opts?: CustomResourceOptions): PolicyLbPool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_monitor_path: Optional[str] = None,
        active_monitor_paths: Optional[Sequence[str]] = None,
        algorithm: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        member_group: Optional[PolicyLbPoolMemberGroupArgs] = None,
        members: Optional[Sequence[PolicyLbPoolMemberArgs]] = None,
        min_active_members: Optional[float] = None,
        nsx_id: Optional[str] = None,
        passive_monitor_path: Optional[str] = None,
        path: Optional[str] = None,
        policy_lb_pool_id: Optional[str] = None,
        revision: Optional[float] = None,
        snat: Optional[PolicyLbPoolSnatArgs] = None,
        tags: Optional[Sequence[PolicyLbPoolTagArgs]] = None,
        tcp_multiplexing_enabled: Optional[bool] = None,
        tcp_multiplexing_number: Optional[float] = None) -> PolicyLbPool
func GetPolicyLbPool(ctx *Context, name string, id IDInput, state *PolicyLbPoolState, opts ...ResourceOption) (*PolicyLbPool, error)
public static PolicyLbPool Get(string name, Input<string> id, PolicyLbPoolState? state, CustomResourceOptions? opts = null)
public static PolicyLbPool get(String name, Output<String> id, PolicyLbPoolState state, CustomResourceOptions options)
resources:  _:    type: nsxt:PolicyLbPool    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:
ActiveMonitorPath string
Active monitor to be associated with this pool.

Deprecated: Deprecated

ActiveMonitorPaths List<string>
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
Algorithm string
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
MemberGroup PolicyLbPoolMemberGroup
Grouping specification for pool members. When member_group is set, member should not be specified.
Members List<PolicyLbPoolMember>
Members of the pool. When member' is set, member_group` should not be specified.
MinActiveMembers double
A pool is considered active if there are at least certain minimum number of members.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PassiveMonitorPath string
Passive monitor to be associated with this pool.
Path string
The NSX path of the policy resource.
PolicyLbPoolId string
ID of the Security Policy.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Snat PolicyLbPoolSnat
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
Tags List<PolicyLbPoolTag>
A list of scope + tag pairs to associate with this resource.
TcpMultiplexingEnabled bool
Enable TCP multiplexing within the pool.
TcpMultiplexingNumber double
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
ActiveMonitorPath string
Active monitor to be associated with this pool.

Deprecated: Deprecated

ActiveMonitorPaths []string
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
Algorithm string
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
MemberGroup PolicyLbPoolMemberGroupArgs
Grouping specification for pool members. When member_group is set, member should not be specified.
Members []PolicyLbPoolMemberArgs
Members of the pool. When member' is set, member_group` should not be specified.
MinActiveMembers float64
A pool is considered active if there are at least certain minimum number of members.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PassiveMonitorPath string
Passive monitor to be associated with this pool.
Path string
The NSX path of the policy resource.
PolicyLbPoolId string
ID of the Security Policy.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Snat PolicyLbPoolSnatArgs
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
Tags []PolicyLbPoolTagArgs
A list of scope + tag pairs to associate with this resource.
TcpMultiplexingEnabled bool
Enable TCP multiplexing within the pool.
TcpMultiplexingNumber float64
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
activeMonitorPath String
Active monitor to be associated with this pool.

Deprecated: Deprecated

activeMonitorPaths List<String>
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
algorithm String
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
description String
Description of the resource.
displayName String
Display name of the resource.
memberGroup PolicyLbPoolMemberGroup
Grouping specification for pool members. When member_group is set, member should not be specified.
members List<PolicyLbPoolMember>
Members of the pool. When member' is set, member_group` should not be specified.
minActiveMembers Double
A pool is considered active if there are at least certain minimum number of members.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
passiveMonitorPath String
Passive monitor to be associated with this pool.
path String
The NSX path of the policy resource.
policyLbPoolId String
ID of the Security Policy.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
snat PolicyLbPoolSnat
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
tags List<PolicyLbPoolTag>
A list of scope + tag pairs to associate with this resource.
tcpMultiplexingEnabled Boolean
Enable TCP multiplexing within the pool.
tcpMultiplexingNumber Double
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
activeMonitorPath string
Active monitor to be associated with this pool.

Deprecated: Deprecated

activeMonitorPaths string[]
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
algorithm string
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
description string
Description of the resource.
displayName string
Display name of the resource.
memberGroup PolicyLbPoolMemberGroup
Grouping specification for pool members. When member_group is set, member should not be specified.
members PolicyLbPoolMember[]
Members of the pool. When member' is set, member_group` should not be specified.
minActiveMembers number
A pool is considered active if there are at least certain minimum number of members.
nsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
passiveMonitorPath string
Passive monitor to be associated with this pool.
path string
The NSX path of the policy resource.
policyLbPoolId string
ID of the Security Policy.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
snat PolicyLbPoolSnat
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
tags PolicyLbPoolTag[]
A list of scope + tag pairs to associate with this resource.
tcpMultiplexingEnabled boolean
Enable TCP multiplexing within the pool.
tcpMultiplexingNumber number
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
active_monitor_path str
Active monitor to be associated with this pool.

Deprecated: Deprecated

active_monitor_paths Sequence[str]
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
algorithm str
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
description str
Description of the resource.
display_name str
Display name of the resource.
member_group PolicyLbPoolMemberGroupArgs
Grouping specification for pool members. When member_group is set, member should not be specified.
members Sequence[PolicyLbPoolMemberArgs]
Members of the pool. When member' is set, member_group` should not be specified.
min_active_members float
A pool is considered active if there are at least certain minimum number of members.
nsx_id str
The NSX ID of this resource. If set, this ID will be used to create the resource.
passive_monitor_path str
Passive monitor to be associated with this pool.
path str
The NSX path of the policy resource.
policy_lb_pool_id str
ID of the Security Policy.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
snat PolicyLbPoolSnatArgs
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
tags Sequence[PolicyLbPoolTagArgs]
A list of scope + tag pairs to associate with this resource.
tcp_multiplexing_enabled bool
Enable TCP multiplexing within the pool.
tcp_multiplexing_number float
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.
activeMonitorPath String
Active monitor to be associated with this pool.

Deprecated: Deprecated

activeMonitorPaths List<String>
Used by the load balancer to initiate new connections to the servers to check their health. Active healthchecks are deactivated by default and can be activated using this setting
algorithm String
Load balancing algorithm, one of ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH. Default is ROUND_ROBIN.
description String
Description of the resource.
displayName String
Display name of the resource.
memberGroup Property Map
Grouping specification for pool members. When member_group is set, member should not be specified.
members List<Property Map>
Members of the pool. When member' is set, member_group` should not be specified.
minActiveMembers Number
A pool is considered active if there are at least certain minimum number of members.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
passiveMonitorPath String
Passive monitor to be associated with this pool.
path String
The NSX path of the policy resource.
policyLbPoolId String
ID of the Security Policy.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
snat Property Map
Source NAT may be required to ensure traffic from the server destined to the client is received by the load balancer.
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.
tcpMultiplexingEnabled Boolean
Enable TCP multiplexing within the pool.
tcpMultiplexingNumber Number
The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.

Supporting Types

PolicyLbPoolMember
, PolicyLbPoolMemberArgs

IpAddress This property is required. string
Member IP address.
AdminState string
One of ENABLED, DISABLED, GRACEFUL_DISABLED. Default is ENABLED.
BackupMember bool
Whether this member is a backup member.
DisplayName string
Display name of the member.
MaxConcurrentConnections double
To ensure members are not overloaded, connections to a member can be capped by this setting.
Port string
If port is specified, all connections will be redirected to this port.
Weight double
Pool member weight is used for WEIGHTED algorithms.
IpAddress This property is required. string
Member IP address.
AdminState string
One of ENABLED, DISABLED, GRACEFUL_DISABLED. Default is ENABLED.
BackupMember bool
Whether this member is a backup member.
DisplayName string
Display name of the member.
MaxConcurrentConnections float64
To ensure members are not overloaded, connections to a member can be capped by this setting.
Port string
If port is specified, all connections will be redirected to this port.
Weight float64
Pool member weight is used for WEIGHTED algorithms.
ipAddress This property is required. String
Member IP address.
adminState String
One of ENABLED, DISABLED, GRACEFUL_DISABLED. Default is ENABLED.
backupMember Boolean
Whether this member is a backup member.
displayName String
Display name of the member.
maxConcurrentConnections Double
To ensure members are not overloaded, connections to a member can be capped by this setting.
port String
If port is specified, all connections will be redirected to this port.
weight Double
Pool member weight is used for WEIGHTED algorithms.
ipAddress This property is required. string
Member IP address.
adminState string
One of ENABLED, DISABLED, GRACEFUL_DISABLED. Default is ENABLED.
backupMember boolean
Whether this member is a backup member.
displayName string
Display name of the member.
maxConcurrentConnections number
To ensure members are not overloaded, connections to a member can be capped by this setting.
port string
If port is specified, all connections will be redirected to this port.
weight number
Pool member weight is used for WEIGHTED algorithms.
ip_address This property is required. str
Member IP address.
admin_state str
One of ENABLED, DISABLED, GRACEFUL_DISABLED. Default is ENABLED.
backup_member bool
Whether this member is a backup member.
display_name str
Display name of the member.
max_concurrent_connections float
To ensure members are not overloaded, connections to a member can be capped by this setting.
port str
If port is specified, all connections will be redirected to this port.
weight float
Pool member weight is used for WEIGHTED algorithms.
ipAddress This property is required. String
Member IP address.
adminState String
One of ENABLED, DISABLED, GRACEFUL_DISABLED. Default is ENABLED.
backupMember Boolean
Whether this member is a backup member.
displayName String
Display name of the member.
maxConcurrentConnections Number
To ensure members are not overloaded, connections to a member can be capped by this setting.
port String
If port is specified, all connections will be redirected to this port.
weight Number
Pool member weight is used for WEIGHTED algorithms.

PolicyLbPoolMemberGroup
, PolicyLbPoolMemberGroupArgs

GroupPath This property is required. string
Path for policy group.
AllowIpv4 bool
Use IPv4 addresses from the grouping object, default is true.
AllowIpv6 bool
Use IPv6 addresses from the grouping object, default is false. Note: this setting is only supported for pools that contain IPv6 addresses.
MaxIpListSize double
Maximum number of IPs to use from the grouping object.
Port string
If port is specified, all connections will be redirected to this port.
GroupPath This property is required. string
Path for policy group.
AllowIpv4 bool
Use IPv4 addresses from the grouping object, default is true.
AllowIpv6 bool
Use IPv6 addresses from the grouping object, default is false. Note: this setting is only supported for pools that contain IPv6 addresses.
MaxIpListSize float64
Maximum number of IPs to use from the grouping object.
Port string
If port is specified, all connections will be redirected to this port.
groupPath This property is required. String
Path for policy group.
allowIpv4 Boolean
Use IPv4 addresses from the grouping object, default is true.
allowIpv6 Boolean
Use IPv6 addresses from the grouping object, default is false. Note: this setting is only supported for pools that contain IPv6 addresses.
maxIpListSize Double
Maximum number of IPs to use from the grouping object.
port String
If port is specified, all connections will be redirected to this port.
groupPath This property is required. string
Path for policy group.
allowIpv4 boolean
Use IPv4 addresses from the grouping object, default is true.
allowIpv6 boolean
Use IPv6 addresses from the grouping object, default is false. Note: this setting is only supported for pools that contain IPv6 addresses.
maxIpListSize number
Maximum number of IPs to use from the grouping object.
port string
If port is specified, all connections will be redirected to this port.
group_path This property is required. str
Path for policy group.
allow_ipv4 bool
Use IPv4 addresses from the grouping object, default is true.
allow_ipv6 bool
Use IPv6 addresses from the grouping object, default is false. Note: this setting is only supported for pools that contain IPv6 addresses.
max_ip_list_size float
Maximum number of IPs to use from the grouping object.
port str
If port is specified, all connections will be redirected to this port.
groupPath This property is required. String
Path for policy group.
allowIpv4 Boolean
Use IPv4 addresses from the grouping object, default is true.
allowIpv6 Boolean
Use IPv6 addresses from the grouping object, default is false. Note: this setting is only supported for pools that contain IPv6 addresses.
maxIpListSize Number
Maximum number of IPs to use from the grouping object.
port String
If port is specified, all connections will be redirected to this port.

PolicyLbPoolSnat
, PolicyLbPoolSnatArgs

IpPoolAddresses List<string>
List of IP ranges or IP CIDRs to use for IPPOOL SNAT type.
Type string
SNAT type, one of AUTOMAP, DISABLED, IPPOOL. Default is AUTOMAP.
IpPoolAddresses []string
List of IP ranges or IP CIDRs to use for IPPOOL SNAT type.
Type string
SNAT type, one of AUTOMAP, DISABLED, IPPOOL. Default is AUTOMAP.
ipPoolAddresses List<String>
List of IP ranges or IP CIDRs to use for IPPOOL SNAT type.
type String
SNAT type, one of AUTOMAP, DISABLED, IPPOOL. Default is AUTOMAP.
ipPoolAddresses string[]
List of IP ranges or IP CIDRs to use for IPPOOL SNAT type.
type string
SNAT type, one of AUTOMAP, DISABLED, IPPOOL. Default is AUTOMAP.
ip_pool_addresses Sequence[str]
List of IP ranges or IP CIDRs to use for IPPOOL SNAT type.
type str
SNAT type, one of AUTOMAP, DISABLED, IPPOOL. Default is AUTOMAP.
ipPoolAddresses List<String>
List of IP ranges or IP CIDRs to use for IPPOOL SNAT type.
type String
SNAT type, one of AUTOMAP, DISABLED, IPPOOL. Default is AUTOMAP.

PolicyLbPoolTag
, PolicyLbPoolTagArgs

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

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.