Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. Pool
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.Pool

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

    <!–

    Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

    –>

    layout: “avi”

    page_title: “Avi: avi.Pool” sidebar_current: “docs-avi-resource-pool” description: |- Creates and manages Avi Pool.

    avi.Pool

    The Pool resource allows the creation and management of Avi Pool

    Example Usage

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

const foo = new avi.Pool("foo", {tenantRef: "/api/tenant/?name=admin"});

    import pulumi
import pulumi_avi as avi

foo = avi.Pool("foo", tenant_ref="/api/tenant/?name=admin")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewPool(ctx, "foo", &avi.PoolArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Pool("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Pool;
import com.pulumi.avi.PoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo = new Pool("foo", PoolArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

    resources:
  foo:
    type: avi:Pool
    properties:
      tenantRef: /api/tenant/?name=admin

    Create Pool Resource

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

    Constructor syntax

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

@overload
def Pool(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         analytics_policies: Optional[Sequence[PoolAnalyticsPolicyArgs]] = None,
         analytics_profile_ref: Optional[str] = None,
         append_port: Optional[str] = None,
         application_persistence_profile_ref: Optional[str] = None,
         autoscale_launch_config_ref: Optional[str] = None,
         autoscale_networks: Optional[Sequence[str]] = None,
         autoscale_policy_ref: Optional[str] = None,
         capacity_estimation: Optional[str] = None,
         capacity_estimation_ttfb_thresh: Optional[str] = None,
         cloud_config_cksum: Optional[str] = None,
         cloud_ref: Optional[str] = None,
         configpb_attributes: Optional[Sequence[PoolConfigpbAttributeArgs]] = None,
         conn_pool_properties: Optional[Sequence[PoolConnPoolPropertyArgs]] = None,
         connection_ramp_duration: Optional[str] = None,
         created_by: Optional[str] = None,
         default_server_port: Optional[str] = None,
         delete_server_on_dns_refresh: Optional[str] = None,
         description: Optional[str] = None,
         domain_names: Optional[Sequence[str]] = None,
         east_west: Optional[str] = None,
         enable_http2: Optional[str] = None,
         enabled: Optional[str] = None,
         external_autoscale_groups: Optional[Sequence[str]] = None,
         fail_actions: Optional[Sequence[PoolFailActionArgs]] = None,
         fewest_tasks_feedback_delay: Optional[str] = None,
         graceful_disable_timeout: Optional[str] = None,
         graceful_hm_down_disable_timeout: Optional[str] = None,
         gslb_sp_enabled: Optional[str] = None,
         health_monitor_refs: Optional[Sequence[str]] = None,
         horizon_profiles: Optional[Sequence[PoolHorizonProfileArgs]] = None,
         host_check_enabled: Optional[str] = None,
         http2_properties: Optional[Sequence[PoolHttp2PropertyArgs]] = None,
         ignore_server_port: Optional[str] = None,
         ignore_servers: Optional[bool] = None,
         inline_health_monitor: Optional[str] = None,
         ipaddrgroup_ref: Optional[str] = None,
         lb_algo_rr_per_se: Optional[str] = None,
         lb_algorithm: Optional[str] = None,
         lb_algorithm_consistent_hash_hdr: Optional[str] = None,
         lb_algorithm_core_nonaffinity: Optional[str] = None,
         lb_algorithm_hash: Optional[str] = None,
         lookup_server_by_name: Optional[str] = None,
         markers: Optional[Sequence[PoolMarkerArgs]] = None,
         max_concurrent_connections_per_server: Optional[str] = None,
         max_conn_rate_per_servers: Optional[Sequence[PoolMaxConnRatePerServerArgs]] = None,
         min_health_monitors_up: Optional[str] = None,
         min_servers_up: Optional[str] = None,
         name: Optional[str] = None,
         networks: Optional[Sequence[PoolNetworkArgs]] = None,
         nsx_securitygroups: Optional[Sequence[str]] = None,
         pki_profile_ref: Optional[str] = None,
         placement_networks: Optional[Sequence[PoolPlacementNetworkArgs]] = None,
         pool_id: Optional[str] = None,
         pool_type: Optional[str] = None,
         request_queue_depth: Optional[str] = None,
         request_queue_enabled: Optional[str] = None,
         resolve_pool_by_dns: Optional[str] = None,
         rewrite_host_header_to_server_name: Optional[str] = None,
         rewrite_host_header_to_sni: Optional[str] = None,
         routing_pool: Optional[str] = None,
         server_disable_type: Optional[str] = None,
         server_name: Optional[str] = None,
         server_reselects: Optional[Sequence[PoolServerReselectArgs]] = None,
         server_timeout: Optional[str] = None,
         servers: Optional[Sequence[PoolServerArgs]] = None,
         service_metadata: Optional[str] = None,
         sni_enabled: Optional[str] = None,
         sp_gs_infos: Optional[Sequence[PoolSpGsInfoArgs]] = None,
         ssl_key_and_certificate_ref: Optional[str] = None,
         ssl_profile_ref: Optional[str] = None,
         tenant_ref: Optional[str] = None,
         tier1_lr: Optional[str] = None,
         use_service_port: Optional[str] = None,
         use_service_ssl_mode: Optional[str] = None,
         uuid: Optional[str] = None,
         vrf_ref: Optional[str] = None)
    func NewPool(ctx *Context, name string, args *PoolArgs, opts ...ResourceOption) (*Pool, error)
    public Pool(string name, PoolArgs? args = null, CustomResourceOptions? opts = null)
    public Pool(String name, PoolArgs args)
public Pool(String name, PoolArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args PoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PoolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PoolArgs
    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 poolResource = new Avi.Pool("poolResource", new()
{
    AnalyticsPolicies = new[]
    {
        new Avi.Inputs.PoolAnalyticsPolicyArgs
        {
            MetricsRealtimeUpdates = new[]
            {
                new Avi.Inputs.PoolAnalyticsPolicyMetricsRealtimeUpdateArgs
                {
                    Enabled = "string",
                    Duration = "string",
                },
            },
        },
    },
    AnalyticsProfileRef = "string",
    AppendPort = "string",
    ApplicationPersistenceProfileRef = "string",
    AutoscaleLaunchConfigRef = "string",
    AutoscaleNetworks = new[]
    {
        "string",
    },
    AutoscalePolicyRef = "string",
    CapacityEstimation = "string",
    CapacityEstimationTtfbThresh = "string",
    CloudConfigCksum = "string",
    CloudRef = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.PoolConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    ConnPoolProperties = new[]
    {
        new Avi.Inputs.PoolConnPoolPropertyArgs
        {
            UpstreamConnpoolConnIdleTmo = "string",
            UpstreamConnpoolConnLifeTmo = "string",
            UpstreamConnpoolConnMaxReuse = "string",
            UpstreamConnpoolServerMaxCache = "string",
        },
    },
    ConnectionRampDuration = "string",
    CreatedBy = "string",
    DefaultServerPort = "string",
    DeleteServerOnDnsRefresh = "string",
    Description = "string",
    DomainNames = new[]
    {
        "string",
    },
    EastWest = "string",
    EnableHttp2 = "string",
    Enabled = "string",
    ExternalAutoscaleGroups = new[]
    {
        "string",
    },
    FailActions = new[]
    {
        new Avi.Inputs.PoolFailActionArgs
        {
            Type = "string",
            LocalRsps = new[]
            {
                new Avi.Inputs.PoolFailActionLocalRspArgs
                {
                    Files = new[]
                    {
                        new Avi.Inputs.PoolFailActionLocalRspFileArgs
                        {
                            ContentType = "string",
                            FileContent = "string",
                            FileLength = "string",
                        },
                    },
                    StatusCode = "string",
                },
            },
            Redirects = new[]
            {
                new Avi.Inputs.PoolFailActionRedirectArgs
                {
                    Host = "string",
                    Path = "string",
                    Protocol = "string",
                    Query = "string",
                    StatusCode = "string",
                },
            },
        },
    },
    FewestTasksFeedbackDelay = "string",
    GracefulDisableTimeout = "string",
    GracefulHmDownDisableTimeout = "string",
    GslbSpEnabled = "string",
    HealthMonitorRefs = new[]
    {
        "string",
    },
    HorizonProfiles = new[]
    {
        new Avi.Inputs.PoolHorizonProfileArgs
        {
            BlastPort = "string",
            PcoipPort = "string",
        },
    },
    HostCheckEnabled = "string",
    Http2Properties = new[]
    {
        new Avi.Inputs.PoolHttp2PropertyArgs
        {
            MaxHttp2ControlFramesPerConnection = "string",
            MaxHttp2HeaderFieldSize = "string",
        },
    },
    IgnoreServerPort = "string",
    IgnoreServers = false,
    InlineHealthMonitor = "string",
    IpaddrgroupRef = "string",
    LbAlgoRrPerSe = "string",
    LbAlgorithm = "string",
    LbAlgorithmConsistentHashHdr = "string",
    LbAlgorithmCoreNonaffinity = "string",
    LbAlgorithmHash = "string",
    LookupServerByName = "string",
    Markers = new[]
    {
        new Avi.Inputs.PoolMarkerArgs
        {
            Key = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    MaxConcurrentConnectionsPerServer = "string",
    MaxConnRatePerServers = new[]
    {
        new Avi.Inputs.PoolMaxConnRatePerServerArgs
        {
            Actions = new[]
            {
                new Avi.Inputs.PoolMaxConnRatePerServerActionArgs
                {
                    Files = new[]
                    {
                        new Avi.Inputs.PoolMaxConnRatePerServerActionFileArgs
                        {
                            ContentType = "string",
                            FileContent = "string",
                            FileLength = "string",
                        },
                    },
                    Redirects = new[]
                    {
                        new Avi.Inputs.PoolMaxConnRatePerServerActionRedirectArgs
                        {
                            Protocol = "string",
                            AddString = "string",
                            Hosts = new[]
                            {
                                new Avi.Inputs.PoolMaxConnRatePerServerActionRedirectHostArgs
                                {
                                    Tokens = new[]
                                    {
                                        new Avi.Inputs.PoolMaxConnRatePerServerActionRedirectHostTokenArgs
                                        {
                                            Type = "string",
                                            EndIndex = "string",
                                            StartIndex = "string",
                                            StrValue = "string",
                                        },
                                    },
                                    Type = "string",
                                },
                            },
                            KeepQuery = "string",
                            Paths = new[]
                            {
                                new Avi.Inputs.PoolMaxConnRatePerServerActionRedirectPathArgs
                                {
                                    Tokens = new[]
                                    {
                                        new Avi.Inputs.PoolMaxConnRatePerServerActionRedirectPathTokenArgs
                                        {
                                            Type = "string",
                                            EndIndex = "string",
                                            StartIndex = "string",
                                            StrValue = "string",
                                        },
                                    },
                                    Type = "string",
                                },
                            },
                            Port = "string",
                            StatusCode = "string",
                        },
                    },
                    StatusCode = "string",
                    Type = "string",
                },
            },
            ExplicitTracking = "string",
            FineGrain = "string",
            HttpCookie = "string",
            HttpHeader = "string",
            RateLimiters = new[]
            {
                new Avi.Inputs.PoolMaxConnRatePerServerRateLimiterArgs
                {
                    BurstSz = "string",
                    Count = "string",
                    Name = "string",
                    Period = "string",
                },
            },
        },
    },
    MinHealthMonitorsUp = "string",
    MinServersUp = "string",
    Name = "string",
    Networks = new[]
    {
        new Avi.Inputs.PoolNetworkArgs
        {
            NetworkRef = "string",
            ServerFilter = "string",
        },
    },
    NsxSecuritygroups = new[]
    {
        "string",
    },
    PkiProfileRef = "string",
    PlacementNetworks = new[]
    {
        new Avi.Inputs.PoolPlacementNetworkArgs
        {
            NetworkRef = "string",
            Subnets = new[]
            {
                new Avi.Inputs.PoolPlacementNetworkSubnetArgs
                {
                    IpAddrs = new[]
                    {
                        new Avi.Inputs.PoolPlacementNetworkSubnetIpAddrArgs
                        {
                            Addr = "string",
                            Type = "string",
                        },
                    },
                    Mask = "string",
                },
            },
        },
    },
    PoolId = "string",
    PoolType = "string",
    RequestQueueDepth = "string",
    RequestQueueEnabled = "string",
    ResolvePoolByDns = "string",
    RewriteHostHeaderToServerName = "string",
    RewriteHostHeaderToSni = "string",
    RoutingPool = "string",
    ServerDisableType = "string",
    ServerName = "string",
    ServerReselects = new[]
    {
        new Avi.Inputs.PoolServerReselectArgs
        {
            Enabled = "string",
            NumRetries = "string",
            RetryNonidempotent = "string",
            RetryTimeout = "string",
            SvrRespCodes = new[]
            {
                new Avi.Inputs.PoolServerReselectSvrRespCodeArgs
                {
                    Codes = new[]
                    {
                        0,
                    },
                    Ranges = new[]
                    {
                        new Avi.Inputs.PoolServerReselectSvrRespCodeRangeArgs
                        {
                            Begin = "string",
                            End = "string",
                        },
                    },
                    RespCodeBlocks = new[]
                    {
                        "string",
                    },
                },
            },
        },
    },
    ServerTimeout = "string",
    Servers = new[]
    {
        new Avi.Inputs.PoolServerArgs
        {
            Ips = new[]
            {
                new Avi.Inputs.PoolServerIpArgs
                {
                    Addr = "string",
                    Type = "string",
                },
            },
            NwRef = "string",
            AvailabilityZone = "string",
            DiscoveredNetworks = new[]
            {
                new Avi.Inputs.PoolServerDiscoveredNetworkArgs
                {
                    NetworkRef = "string",
                    Subnet6s = new[]
                    {
                        new Avi.Inputs.PoolServerDiscoveredNetworkSubnet6Args
                        {
                            IpAddrs = new[]
                            {
                                new Avi.Inputs.PoolServerDiscoveredNetworkSubnet6IpAddrArgs
                                {
                                    Addr = "string",
                                    Type = "string",
                                },
                            },
                            Mask = "string",
                        },
                    },
                    Subnets = new[]
                    {
                        new Avi.Inputs.PoolServerDiscoveredNetworkSubnetArgs
                        {
                            IpAddrs = new[]
                            {
                                new Avi.Inputs.PoolServerDiscoveredNetworkSubnetIpAddrArgs
                                {
                                    Addr = "string",
                                    Type = "string",
                                },
                            },
                            Mask = "string",
                        },
                    },
                },
            },
            Enabled = "string",
            ExternalOrchestrationId = "string",
            ExternalUuid = "string",
            HealthMonitorRefs = new[]
            {
                "string",
            },
            Port = "string",
            AutoscalingGroupName = "string",
            Locations = new[]
            {
                new Avi.Inputs.PoolServerLocationArgs
                {
                    Latitude = "string",
                    Longitude = "string",
                    Name = "string",
                    Tag = "string",
                },
            },
            Description = "string",
            MacAddress = "string",
            Hostname = "string",
            PreferenceOrder = "string",
            PrstHdrVal = "string",
            Ratio = "string",
            ResolveServerByDns = "string",
            RewriteHostHeader = "string",
            ServerNode = "string",
            SrvRdatas = new[]
            {
                new Avi.Inputs.PoolServerSrvRdataArgs
                {
                    Port = "string",
                    Priority = "string",
                    Weight = "string",
                },
            },
            Static = "string",
            VerifyNetwork = "string",
            VmRef = "string",
        },
    },
    ServiceMetadata = "string",
    SniEnabled = "string",
    SpGsInfos = new[]
    {
        new Avi.Inputs.PoolSpGsInfoArgs
        {
            Fqdns = new[]
            {
                "string",
            },
            GsRef = "string",
        },
    },
    SslKeyAndCertificateRef = "string",
    SslProfileRef = "string",
    TenantRef = "string",
    Tier1Lr = "string",
    UseServicePort = "string",
    UseServiceSslMode = "string",
    Uuid = "string",
    VrfRef = "string",
});

    example, err := avi.NewPool(ctx, "poolResource", &avi.PoolArgs{
	AnalyticsPolicies: avi.PoolAnalyticsPolicyArray{
		&avi.PoolAnalyticsPolicyArgs{
			MetricsRealtimeUpdates: avi.PoolAnalyticsPolicyMetricsRealtimeUpdateArray{
				&avi.PoolAnalyticsPolicyMetricsRealtimeUpdateArgs{
					Enabled:  pulumi.String("string"),
					Duration: pulumi.String("string"),
				},
			},
		},
	},
	AnalyticsProfileRef:              pulumi.String("string"),
	AppendPort:                       pulumi.String("string"),
	ApplicationPersistenceProfileRef: pulumi.String("string"),
	AutoscaleLaunchConfigRef:         pulumi.String("string"),
	AutoscaleNetworks: pulumi.StringArray{
		pulumi.String("string"),
	},
	AutoscalePolicyRef:           pulumi.String("string"),
	CapacityEstimation:           pulumi.String("string"),
	CapacityEstimationTtfbThresh: pulumi.String("string"),
	CloudConfigCksum:             pulumi.String("string"),
	CloudRef:                     pulumi.String("string"),
	ConfigpbAttributes: avi.PoolConfigpbAttributeArray{
		&avi.PoolConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	ConnPoolProperties: avi.PoolConnPoolPropertyArray{
		&avi.PoolConnPoolPropertyArgs{
			UpstreamConnpoolConnIdleTmo:    pulumi.String("string"),
			UpstreamConnpoolConnLifeTmo:    pulumi.String("string"),
			UpstreamConnpoolConnMaxReuse:   pulumi.String("string"),
			UpstreamConnpoolServerMaxCache: pulumi.String("string"),
		},
	},
	ConnectionRampDuration:   pulumi.String("string"),
	CreatedBy:                pulumi.String("string"),
	DefaultServerPort:        pulumi.String("string"),
	DeleteServerOnDnsRefresh: pulumi.String("string"),
	Description:              pulumi.String("string"),
	DomainNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	EastWest:    pulumi.String("string"),
	EnableHttp2: pulumi.String("string"),
	Enabled:     pulumi.String("string"),
	ExternalAutoscaleGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	FailActions: avi.PoolFailActionArray{
		&avi.PoolFailActionArgs{
			Type: pulumi.String("string"),
			LocalRsps: avi.PoolFailActionLocalRspArray{
				&avi.PoolFailActionLocalRspArgs{
					Files: avi.PoolFailActionLocalRspFileArray{
						&avi.PoolFailActionLocalRspFileArgs{
							ContentType: pulumi.String("string"),
							FileContent: pulumi.String("string"),
							FileLength:  pulumi.String("string"),
						},
					},
					StatusCode: pulumi.String("string"),
				},
			},
			Redirects: avi.PoolFailActionRedirectArray{
				&avi.PoolFailActionRedirectArgs{
					Host:       pulumi.String("string"),
					Path:       pulumi.String("string"),
					Protocol:   pulumi.String("string"),
					Query:      pulumi.String("string"),
					StatusCode: pulumi.String("string"),
				},
			},
		},
	},
	FewestTasksFeedbackDelay:     pulumi.String("string"),
	GracefulDisableTimeout:       pulumi.String("string"),
	GracefulHmDownDisableTimeout: pulumi.String("string"),
	GslbSpEnabled:                pulumi.String("string"),
	HealthMonitorRefs: pulumi.StringArray{
		pulumi.String("string"),
	},
	HorizonProfiles: avi.PoolHorizonProfileArray{
		&avi.PoolHorizonProfileArgs{
			BlastPort: pulumi.String("string"),
			PcoipPort: pulumi.String("string"),
		},
	},
	HostCheckEnabled: pulumi.String("string"),
	Http2Properties: avi.PoolHttp2PropertyArray{
		&avi.PoolHttp2PropertyArgs{
			MaxHttp2ControlFramesPerConnection: pulumi.String("string"),
			MaxHttp2HeaderFieldSize:            pulumi.String("string"),
		},
	},
	IgnoreServerPort:             pulumi.String("string"),
	IgnoreServers:                pulumi.Bool(false),
	InlineHealthMonitor:          pulumi.String("string"),
	IpaddrgroupRef:               pulumi.String("string"),
	LbAlgoRrPerSe:                pulumi.String("string"),
	LbAlgorithm:                  pulumi.String("string"),
	LbAlgorithmConsistentHashHdr: pulumi.String("string"),
	LbAlgorithmCoreNonaffinity:   pulumi.String("string"),
	LbAlgorithmHash:              pulumi.String("string"),
	LookupServerByName:           pulumi.String("string"),
	Markers: avi.PoolMarkerArray{
		&avi.PoolMarkerArgs{
			Key: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	MaxConcurrentConnectionsPerServer: pulumi.String("string"),
	MaxConnRatePerServers: avi.PoolMaxConnRatePerServerArray{
		&avi.PoolMaxConnRatePerServerArgs{
			Actions: avi.PoolMaxConnRatePerServerActionArray{
				&avi.PoolMaxConnRatePerServerActionArgs{
					Files: avi.PoolMaxConnRatePerServerActionFileArray{
						&avi.PoolMaxConnRatePerServerActionFileArgs{
							ContentType: pulumi.String("string"),
							FileContent: pulumi.String("string"),
							FileLength:  pulumi.String("string"),
						},
					},
					Redirects: avi.PoolMaxConnRatePerServerActionRedirectArray{
						&avi.PoolMaxConnRatePerServerActionRedirectArgs{
							Protocol:  pulumi.String("string"),
							AddString: pulumi.String("string"),
							Hosts: avi.PoolMaxConnRatePerServerActionRedirectHostArray{
								&avi.PoolMaxConnRatePerServerActionRedirectHostArgs{
									Tokens: avi.PoolMaxConnRatePerServerActionRedirectHostTokenArray{
										&avi.PoolMaxConnRatePerServerActionRedirectHostTokenArgs{
											Type:       pulumi.String("string"),
											EndIndex:   pulumi.String("string"),
											StartIndex: pulumi.String("string"),
											StrValue:   pulumi.String("string"),
										},
									},
									Type: pulumi.String("string"),
								},
							},
							KeepQuery: pulumi.String("string"),
							Paths: avi.PoolMaxConnRatePerServerActionRedirectPathArray{
								&avi.PoolMaxConnRatePerServerActionRedirectPathArgs{
									Tokens: avi.PoolMaxConnRatePerServerActionRedirectPathTokenArray{
										&avi.PoolMaxConnRatePerServerActionRedirectPathTokenArgs{
											Type:       pulumi.String("string"),
											EndIndex:   pulumi.String("string"),
											StartIndex: pulumi.String("string"),
											StrValue:   pulumi.String("string"),
										},
									},
									Type: pulumi.String("string"),
								},
							},
							Port:       pulumi.String("string"),
							StatusCode: pulumi.String("string"),
						},
					},
					StatusCode: pulumi.String("string"),
					Type:       pulumi.String("string"),
				},
			},
			ExplicitTracking: pulumi.String("string"),
			FineGrain:        pulumi.String("string"),
			HttpCookie:       pulumi.String("string"),
			HttpHeader:       pulumi.String("string"),
			RateLimiters: avi.PoolMaxConnRatePerServerRateLimiterArray{
				&avi.PoolMaxConnRatePerServerRateLimiterArgs{
					BurstSz: pulumi.String("string"),
					Count:   pulumi.String("string"),
					Name:    pulumi.String("string"),
					Period:  pulumi.String("string"),
				},
			},
		},
	},
	MinHealthMonitorsUp: pulumi.String("string"),
	MinServersUp:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	Networks: avi.PoolNetworkArray{
		&avi.PoolNetworkArgs{
			NetworkRef:   pulumi.String("string"),
			ServerFilter: pulumi.String("string"),
		},
	},
	NsxSecuritygroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	PkiProfileRef: pulumi.String("string"),
	PlacementNetworks: avi.PoolPlacementNetworkArray{
		&avi.PoolPlacementNetworkArgs{
			NetworkRef: pulumi.String("string"),
			Subnets: avi.PoolPlacementNetworkSubnetArray{
				&avi.PoolPlacementNetworkSubnetArgs{
					IpAddrs: avi.PoolPlacementNetworkSubnetIpAddrArray{
						&avi.PoolPlacementNetworkSubnetIpAddrArgs{
							Addr: pulumi.String("string"),
							Type: pulumi.String("string"),
						},
					},
					Mask: pulumi.String("string"),
				},
			},
		},
	},
	PoolId:                        pulumi.String("string"),
	PoolType:                      pulumi.String("string"),
	RequestQueueDepth:             pulumi.String("string"),
	RequestQueueEnabled:           pulumi.String("string"),
	ResolvePoolByDns:              pulumi.String("string"),
	RewriteHostHeaderToServerName: pulumi.String("string"),
	RewriteHostHeaderToSni:        pulumi.String("string"),
	RoutingPool:                   pulumi.String("string"),
	ServerDisableType:             pulumi.String("string"),
	ServerName:                    pulumi.String("string"),
	ServerReselects: avi.PoolServerReselectArray{
		&avi.PoolServerReselectArgs{
			Enabled:            pulumi.String("string"),
			NumRetries:         pulumi.String("string"),
			RetryNonidempotent: pulumi.String("string"),
			RetryTimeout:       pulumi.String("string"),
			SvrRespCodes: avi.PoolServerReselectSvrRespCodeArray{
				&avi.PoolServerReselectSvrRespCodeArgs{
					Codes: pulumi.Float64Array{
						pulumi.Float64(0),
					},
					Ranges: avi.PoolServerReselectSvrRespCodeRangeArray{
						&avi.PoolServerReselectSvrRespCodeRangeArgs{
							Begin: pulumi.String("string"),
							End:   pulumi.String("string"),
						},
					},
					RespCodeBlocks: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
	},
	ServerTimeout: pulumi.String("string"),
	Servers: avi.PoolServerArray{
		&avi.PoolServerArgs{
			Ips: avi.PoolServerIpArray{
				&avi.PoolServerIpArgs{
					Addr: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			NwRef:            pulumi.String("string"),
			AvailabilityZone: pulumi.String("string"),
			DiscoveredNetworks: avi.PoolServerDiscoveredNetworkArray{
				&avi.PoolServerDiscoveredNetworkArgs{
					NetworkRef: pulumi.String("string"),
					Subnet6s: avi.PoolServerDiscoveredNetworkSubnet6Array{
						&avi.PoolServerDiscoveredNetworkSubnet6Args{
							IpAddrs: avi.PoolServerDiscoveredNetworkSubnet6IpAddrArray{
								&avi.PoolServerDiscoveredNetworkSubnet6IpAddrArgs{
									Addr: pulumi.String("string"),
									Type: pulumi.String("string"),
								},
							},
							Mask: pulumi.String("string"),
						},
					},
					Subnets: avi.PoolServerDiscoveredNetworkSubnetArray{
						&avi.PoolServerDiscoveredNetworkSubnetArgs{
							IpAddrs: avi.PoolServerDiscoveredNetworkSubnetIpAddrArray{
								&avi.PoolServerDiscoveredNetworkSubnetIpAddrArgs{
									Addr: pulumi.String("string"),
									Type: pulumi.String("string"),
								},
							},
							Mask: pulumi.String("string"),
						},
					},
				},
			},
			Enabled:                 pulumi.String("string"),
			ExternalOrchestrationId: pulumi.String("string"),
			ExternalUuid:            pulumi.String("string"),
			HealthMonitorRefs: pulumi.StringArray{
				pulumi.String("string"),
			},
			Port:                 pulumi.String("string"),
			AutoscalingGroupName: pulumi.String("string"),
			Locations: avi.PoolServerLocationArray{
				&avi.PoolServerLocationArgs{
					Latitude:  pulumi.String("string"),
					Longitude: pulumi.String("string"),
					Name:      pulumi.String("string"),
					Tag:       pulumi.String("string"),
				},
			},
			Description:        pulumi.String("string"),
			MacAddress:         pulumi.String("string"),
			Hostname:           pulumi.String("string"),
			PreferenceOrder:    pulumi.String("string"),
			PrstHdrVal:         pulumi.String("string"),
			Ratio:              pulumi.String("string"),
			ResolveServerByDns: pulumi.String("string"),
			RewriteHostHeader:  pulumi.String("string"),
			ServerNode:         pulumi.String("string"),
			SrvRdatas: avi.PoolServerSrvRdataArray{
				&avi.PoolServerSrvRdataArgs{
					Port:     pulumi.String("string"),
					Priority: pulumi.String("string"),
					Weight:   pulumi.String("string"),
				},
			},
			Static:        pulumi.String("string"),
			VerifyNetwork: pulumi.String("string"),
			VmRef:         pulumi.String("string"),
		},
	},
	ServiceMetadata: pulumi.String("string"),
	SniEnabled:      pulumi.String("string"),
	SpGsInfos: avi.PoolSpGsInfoArray{
		&avi.PoolSpGsInfoArgs{
			Fqdns: pulumi.StringArray{
				pulumi.String("string"),
			},
			GsRef: pulumi.String("string"),
		},
	},
	SslKeyAndCertificateRef: pulumi.String("string"),
	SslProfileRef:           pulumi.String("string"),
	TenantRef:               pulumi.String("string"),
	Tier1Lr:                 pulumi.String("string"),
	UseServicePort:          pulumi.String("string"),
	UseServiceSslMode:       pulumi.String("string"),
	Uuid:                    pulumi.String("string"),
	VrfRef:                  pulumi.String("string"),
})

    var poolResource = new Pool("poolResource", PoolArgs.builder()
    .analyticsPolicies(PoolAnalyticsPolicyArgs.builder()
        .metricsRealtimeUpdates(PoolAnalyticsPolicyMetricsRealtimeUpdateArgs.builder()
            .enabled("string")
            .duration("string")
            .build())
        .build())
    .analyticsProfileRef("string")
    .appendPort("string")
    .applicationPersistenceProfileRef("string")
    .autoscaleLaunchConfigRef("string")
    .autoscaleNetworks("string")
    .autoscalePolicyRef("string")
    .capacityEstimation("string")
    .capacityEstimationTtfbThresh("string")
    .cloudConfigCksum("string")
    .cloudRef("string")
    .configpbAttributes(PoolConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .connPoolProperties(PoolConnPoolPropertyArgs.builder()
        .upstreamConnpoolConnIdleTmo("string")
        .upstreamConnpoolConnLifeTmo("string")
        .upstreamConnpoolConnMaxReuse("string")
        .upstreamConnpoolServerMaxCache("string")
        .build())
    .connectionRampDuration("string")
    .createdBy("string")
    .defaultServerPort("string")
    .deleteServerOnDnsRefresh("string")
    .description("string")
    .domainNames("string")
    .eastWest("string")
    .enableHttp2("string")
    .enabled("string")
    .externalAutoscaleGroups("string")
    .failActions(PoolFailActionArgs.builder()
        .type("string")
        .localRsps(PoolFailActionLocalRspArgs.builder()
            .files(PoolFailActionLocalRspFileArgs.builder()
                .contentType("string")
                .fileContent("string")
                .fileLength("string")
                .build())
            .statusCode("string")
            .build())
        .redirects(PoolFailActionRedirectArgs.builder()
            .host("string")
            .path("string")
            .protocol("string")
            .query("string")
            .statusCode("string")
            .build())
        .build())
    .fewestTasksFeedbackDelay("string")
    .gracefulDisableTimeout("string")
    .gracefulHmDownDisableTimeout("string")
    .gslbSpEnabled("string")
    .healthMonitorRefs("string")
    .horizonProfiles(PoolHorizonProfileArgs.builder()
        .blastPort("string")
        .pcoipPort("string")
        .build())
    .hostCheckEnabled("string")
    .http2Properties(PoolHttp2PropertyArgs.builder()
        .maxHttp2ControlFramesPerConnection("string")
        .maxHttp2HeaderFieldSize("string")
        .build())
    .ignoreServerPort("string")
    .ignoreServers(false)
    .inlineHealthMonitor("string")
    .ipaddrgroupRef("string")
    .lbAlgoRrPerSe("string")
    .lbAlgorithm("string")
    .lbAlgorithmConsistentHashHdr("string")
    .lbAlgorithmCoreNonaffinity("string")
    .lbAlgorithmHash("string")
    .lookupServerByName("string")
    .markers(PoolMarkerArgs.builder()
        .key("string")
        .values("string")
        .build())
    .maxConcurrentConnectionsPerServer("string")
    .maxConnRatePerServers(PoolMaxConnRatePerServerArgs.builder()
        .actions(PoolMaxConnRatePerServerActionArgs.builder()
            .files(PoolMaxConnRatePerServerActionFileArgs.builder()
                .contentType("string")
                .fileContent("string")
                .fileLength("string")
                .build())
            .redirects(PoolMaxConnRatePerServerActionRedirectArgs.builder()
                .protocol("string")
                .addString("string")
                .hosts(PoolMaxConnRatePerServerActionRedirectHostArgs.builder()
                    .tokens(PoolMaxConnRatePerServerActionRedirectHostTokenArgs.builder()
                        .type("string")
                        .endIndex("string")
                        .startIndex("string")
                        .strValue("string")
                        .build())
                    .type("string")
                    .build())
                .keepQuery("string")
                .paths(PoolMaxConnRatePerServerActionRedirectPathArgs.builder()
                    .tokens(PoolMaxConnRatePerServerActionRedirectPathTokenArgs.builder()
                        .type("string")
                        .endIndex("string")
                        .startIndex("string")
                        .strValue("string")
                        .build())
                    .type("string")
                    .build())
                .port("string")
                .statusCode("string")
                .build())
            .statusCode("string")
            .type("string")
            .build())
        .explicitTracking("string")
        .fineGrain("string")
        .httpCookie("string")
        .httpHeader("string")
        .rateLimiters(PoolMaxConnRatePerServerRateLimiterArgs.builder()
            .burstSz("string")
            .count("string")
            .name("string")
            .period("string")
            .build())
        .build())
    .minHealthMonitorsUp("string")
    .minServersUp("string")
    .name("string")
    .networks(PoolNetworkArgs.builder()
        .networkRef("string")
        .serverFilter("string")
        .build())
    .nsxSecuritygroups("string")
    .pkiProfileRef("string")
    .placementNetworks(PoolPlacementNetworkArgs.builder()
        .networkRef("string")
        .subnets(PoolPlacementNetworkSubnetArgs.builder()
            .ipAddrs(PoolPlacementNetworkSubnetIpAddrArgs.builder()
                .addr("string")
                .type("string")
                .build())
            .mask("string")
            .build())
        .build())
    .poolId("string")
    .poolType("string")
    .requestQueueDepth("string")
    .requestQueueEnabled("string")
    .resolvePoolByDns("string")
    .rewriteHostHeaderToServerName("string")
    .rewriteHostHeaderToSni("string")
    .routingPool("string")
    .serverDisableType("string")
    .serverName("string")
    .serverReselects(PoolServerReselectArgs.builder()
        .enabled("string")
        .numRetries("string")
        .retryNonidempotent("string")
        .retryTimeout("string")
        .svrRespCodes(PoolServerReselectSvrRespCodeArgs.builder()
            .codes(0)
            .ranges(PoolServerReselectSvrRespCodeRangeArgs.builder()
                .begin("string")
                .end("string")
                .build())
            .respCodeBlocks("string")
            .build())
        .build())
    .serverTimeout("string")
    .servers(PoolServerArgs.builder()
        .ips(PoolServerIpArgs.builder()
            .addr("string")
            .type("string")
            .build())
        .nwRef("string")
        .availabilityZone("string")
        .discoveredNetworks(PoolServerDiscoveredNetworkArgs.builder()
            .networkRef("string")
            .subnet6s(PoolServerDiscoveredNetworkSubnet6Args.builder()
                .ipAddrs(PoolServerDiscoveredNetworkSubnet6IpAddrArgs.builder()
                    .addr("string")
                    .type("string")
                    .build())
                .mask("string")
                .build())
            .subnets(PoolServerDiscoveredNetworkSubnetArgs.builder()
                .ipAddrs(PoolServerDiscoveredNetworkSubnetIpAddrArgs.builder()
                    .addr("string")
                    .type("string")
                    .build())
                .mask("string")
                .build())
            .build())
        .enabled("string")
        .externalOrchestrationId("string")
        .externalUuid("string")
        .healthMonitorRefs("string")
        .port("string")
        .autoscalingGroupName("string")
        .locations(PoolServerLocationArgs.builder()
            .latitude("string")
            .longitude("string")
            .name("string")
            .tag("string")
            .build())
        .description("string")
        .macAddress("string")
        .hostname("string")
        .preferenceOrder("string")
        .prstHdrVal("string")
        .ratio("string")
        .resolveServerByDns("string")
        .rewriteHostHeader("string")
        .serverNode("string")
        .srvRdatas(PoolServerSrvRdataArgs.builder()
            .port("string")
            .priority("string")
            .weight("string")
            .build())
        .static_("string")
        .verifyNetwork("string")
        .vmRef("string")
        .build())
    .serviceMetadata("string")
    .sniEnabled("string")
    .spGsInfos(PoolSpGsInfoArgs.builder()
        .fqdns("string")
        .gsRef("string")
        .build())
    .sslKeyAndCertificateRef("string")
    .sslProfileRef("string")
    .tenantRef("string")
    .tier1Lr("string")
    .useServicePort("string")
    .useServiceSslMode("string")
    .uuid("string")
    .vrfRef("string")
    .build());

    pool_resource = avi.Pool("poolResource",
    analytics_policies=[{
        "metrics_realtime_updates": [{
            "enabled": "string",
            "duration": "string",
        }],
    }],
    analytics_profile_ref="string",
    append_port="string",
    application_persistence_profile_ref="string",
    autoscale_launch_config_ref="string",
    autoscale_networks=["string"],
    autoscale_policy_ref="string",
    capacity_estimation="string",
    capacity_estimation_ttfb_thresh="string",
    cloud_config_cksum="string",
    cloud_ref="string",
    configpb_attributes=[{
        "version": "string",
    }],
    conn_pool_properties=[{
        "upstream_connpool_conn_idle_tmo": "string",
        "upstream_connpool_conn_life_tmo": "string",
        "upstream_connpool_conn_max_reuse": "string",
        "upstream_connpool_server_max_cache": "string",
    }],
    connection_ramp_duration="string",
    created_by="string",
    default_server_port="string",
    delete_server_on_dns_refresh="string",
    description="string",
    domain_names=["string"],
    east_west="string",
    enable_http2="string",
    enabled="string",
    external_autoscale_groups=["string"],
    fail_actions=[{
        "type": "string",
        "local_rsps": [{
            "files": [{
                "content_type": "string",
                "file_content": "string",
                "file_length": "string",
            }],
            "status_code": "string",
        }],
        "redirects": [{
            "host": "string",
            "path": "string",
            "protocol": "string",
            "query": "string",
            "status_code": "string",
        }],
    }],
    fewest_tasks_feedback_delay="string",
    graceful_disable_timeout="string",
    graceful_hm_down_disable_timeout="string",
    gslb_sp_enabled="string",
    health_monitor_refs=["string"],
    horizon_profiles=[{
        "blast_port": "string",
        "pcoip_port": "string",
    }],
    host_check_enabled="string",
    http2_properties=[{
        "max_http2_control_frames_per_connection": "string",
        "max_http2_header_field_size": "string",
    }],
    ignore_server_port="string",
    ignore_servers=False,
    inline_health_monitor="string",
    ipaddrgroup_ref="string",
    lb_algo_rr_per_se="string",
    lb_algorithm="string",
    lb_algorithm_consistent_hash_hdr="string",
    lb_algorithm_core_nonaffinity="string",
    lb_algorithm_hash="string",
    lookup_server_by_name="string",
    markers=[{
        "key": "string",
        "values": ["string"],
    }],
    max_concurrent_connections_per_server="string",
    max_conn_rate_per_servers=[{
        "actions": [{
            "files": [{
                "content_type": "string",
                "file_content": "string",
                "file_length": "string",
            }],
            "redirects": [{
                "protocol": "string",
                "add_string": "string",
                "hosts": [{
                    "tokens": [{
                        "type": "string",
                        "end_index": "string",
                        "start_index": "string",
                        "str_value": "string",
                    }],
                    "type": "string",
                }],
                "keep_query": "string",
                "paths": [{
                    "tokens": [{
                        "type": "string",
                        "end_index": "string",
                        "start_index": "string",
                        "str_value": "string",
                    }],
                    "type": "string",
                }],
                "port": "string",
                "status_code": "string",
            }],
            "status_code": "string",
            "type": "string",
        }],
        "explicit_tracking": "string",
        "fine_grain": "string",
        "http_cookie": "string",
        "http_header": "string",
        "rate_limiters": [{
            "burst_sz": "string",
            "count": "string",
            "name": "string",
            "period": "string",
        }],
    }],
    min_health_monitors_up="string",
    min_servers_up="string",
    name="string",
    networks=[{
        "network_ref": "string",
        "server_filter": "string",
    }],
    nsx_securitygroups=["string"],
    pki_profile_ref="string",
    placement_networks=[{
        "network_ref": "string",
        "subnets": [{
            "ip_addrs": [{
                "addr": "string",
                "type": "string",
            }],
            "mask": "string",
        }],
    }],
    pool_id="string",
    pool_type="string",
    request_queue_depth="string",
    request_queue_enabled="string",
    resolve_pool_by_dns="string",
    rewrite_host_header_to_server_name="string",
    rewrite_host_header_to_sni="string",
    routing_pool="string",
    server_disable_type="string",
    server_name="string",
    server_reselects=[{
        "enabled": "string",
        "num_retries": "string",
        "retry_nonidempotent": "string",
        "retry_timeout": "string",
        "svr_resp_codes": [{
            "codes": [0],
            "ranges": [{
                "begin": "string",
                "end": "string",
            }],
            "resp_code_blocks": ["string"],
        }],
    }],
    server_timeout="string",
    servers=[{
        "ips": [{
            "addr": "string",
            "type": "string",
        }],
        "nw_ref": "string",
        "availability_zone": "string",
        "discovered_networks": [{
            "network_ref": "string",
            "subnet6s": [{
                "ip_addrs": [{
                    "addr": "string",
                    "type": "string",
                }],
                "mask": "string",
            }],
            "subnets": [{
                "ip_addrs": [{
                    "addr": "string",
                    "type": "string",
                }],
                "mask": "string",
            }],
        }],
        "enabled": "string",
        "external_orchestration_id": "string",
        "external_uuid": "string",
        "health_monitor_refs": ["string"],
        "port": "string",
        "autoscaling_group_name": "string",
        "locations": [{
            "latitude": "string",
            "longitude": "string",
            "name": "string",
            "tag": "string",
        }],
        "description": "string",
        "mac_address": "string",
        "hostname": "string",
        "preference_order": "string",
        "prst_hdr_val": "string",
        "ratio": "string",
        "resolve_server_by_dns": "string",
        "rewrite_host_header": "string",
        "server_node": "string",
        "srv_rdatas": [{
            "port": "string",
            "priority": "string",
            "weight": "string",
        }],
        "static": "string",
        "verify_network": "string",
        "vm_ref": "string",
    }],
    service_metadata="string",
    sni_enabled="string",
    sp_gs_infos=[{
        "fqdns": ["string"],
        "gs_ref": "string",
    }],
    ssl_key_and_certificate_ref="string",
    ssl_profile_ref="string",
    tenant_ref="string",
    tier1_lr="string",
    use_service_port="string",
    use_service_ssl_mode="string",
    uuid="string",
    vrf_ref="string")

    const poolResource = new avi.Pool("poolResource", {
    analyticsPolicies: [{
        metricsRealtimeUpdates: [{
            enabled: "string",
            duration: "string",
        }],
    }],
    analyticsProfileRef: "string",
    appendPort: "string",
    applicationPersistenceProfileRef: "string",
    autoscaleLaunchConfigRef: "string",
    autoscaleNetworks: ["string"],
    autoscalePolicyRef: "string",
    capacityEstimation: "string",
    capacityEstimationTtfbThresh: "string",
    cloudConfigCksum: "string",
    cloudRef: "string",
    configpbAttributes: [{
        version: "string",
    }],
    connPoolProperties: [{
        upstreamConnpoolConnIdleTmo: "string",
        upstreamConnpoolConnLifeTmo: "string",
        upstreamConnpoolConnMaxReuse: "string",
        upstreamConnpoolServerMaxCache: "string",
    }],
    connectionRampDuration: "string",
    createdBy: "string",
    defaultServerPort: "string",
    deleteServerOnDnsRefresh: "string",
    description: "string",
    domainNames: ["string"],
    eastWest: "string",
    enableHttp2: "string",
    enabled: "string",
    externalAutoscaleGroups: ["string"],
    failActions: [{
        type: "string",
        localRsps: [{
            files: [{
                contentType: "string",
                fileContent: "string",
                fileLength: "string",
            }],
            statusCode: "string",
        }],
        redirects: [{
            host: "string",
            path: "string",
            protocol: "string",
            query: "string",
            statusCode: "string",
        }],
    }],
    fewestTasksFeedbackDelay: "string",
    gracefulDisableTimeout: "string",
    gracefulHmDownDisableTimeout: "string",
    gslbSpEnabled: "string",
    healthMonitorRefs: ["string"],
    horizonProfiles: [{
        blastPort: "string",
        pcoipPort: "string",
    }],
    hostCheckEnabled: "string",
    http2Properties: [{
        maxHttp2ControlFramesPerConnection: "string",
        maxHttp2HeaderFieldSize: "string",
    }],
    ignoreServerPort: "string",
    ignoreServers: false,
    inlineHealthMonitor: "string",
    ipaddrgroupRef: "string",
    lbAlgoRrPerSe: "string",
    lbAlgorithm: "string",
    lbAlgorithmConsistentHashHdr: "string",
    lbAlgorithmCoreNonaffinity: "string",
    lbAlgorithmHash: "string",
    lookupServerByName: "string",
    markers: [{
        key: "string",
        values: ["string"],
    }],
    maxConcurrentConnectionsPerServer: "string",
    maxConnRatePerServers: [{
        actions: [{
            files: [{
                contentType: "string",
                fileContent: "string",
                fileLength: "string",
            }],
            redirects: [{
                protocol: "string",
                addString: "string",
                hosts: [{
                    tokens: [{
                        type: "string",
                        endIndex: "string",
                        startIndex: "string",
                        strValue: "string",
                    }],
                    type: "string",
                }],
                keepQuery: "string",
                paths: [{
                    tokens: [{
                        type: "string",
                        endIndex: "string",
                        startIndex: "string",
                        strValue: "string",
                    }],
                    type: "string",
                }],
                port: "string",
                statusCode: "string",
            }],
            statusCode: "string",
            type: "string",
        }],
        explicitTracking: "string",
        fineGrain: "string",
        httpCookie: "string",
        httpHeader: "string",
        rateLimiters: [{
            burstSz: "string",
            count: "string",
            name: "string",
            period: "string",
        }],
    }],
    minHealthMonitorsUp: "string",
    minServersUp: "string",
    name: "string",
    networks: [{
        networkRef: "string",
        serverFilter: "string",
    }],
    nsxSecuritygroups: ["string"],
    pkiProfileRef: "string",
    placementNetworks: [{
        networkRef: "string",
        subnets: [{
            ipAddrs: [{
                addr: "string",
                type: "string",
            }],
            mask: "string",
        }],
    }],
    poolId: "string",
    poolType: "string",
    requestQueueDepth: "string",
    requestQueueEnabled: "string",
    resolvePoolByDns: "string",
    rewriteHostHeaderToServerName: "string",
    rewriteHostHeaderToSni: "string",
    routingPool: "string",
    serverDisableType: "string",
    serverName: "string",
    serverReselects: [{
        enabled: "string",
        numRetries: "string",
        retryNonidempotent: "string",
        retryTimeout: "string",
        svrRespCodes: [{
            codes: [0],
            ranges: [{
                begin: "string",
                end: "string",
            }],
            respCodeBlocks: ["string"],
        }],
    }],
    serverTimeout: "string",
    servers: [{
        ips: [{
            addr: "string",
            type: "string",
        }],
        nwRef: "string",
        availabilityZone: "string",
        discoveredNetworks: [{
            networkRef: "string",
            subnet6s: [{
                ipAddrs: [{
                    addr: "string",
                    type: "string",
                }],
                mask: "string",
            }],
            subnets: [{
                ipAddrs: [{
                    addr: "string",
                    type: "string",
                }],
                mask: "string",
            }],
        }],
        enabled: "string",
        externalOrchestrationId: "string",
        externalUuid: "string",
        healthMonitorRefs: ["string"],
        port: "string",
        autoscalingGroupName: "string",
        locations: [{
            latitude: "string",
            longitude: "string",
            name: "string",
            tag: "string",
        }],
        description: "string",
        macAddress: "string",
        hostname: "string",
        preferenceOrder: "string",
        prstHdrVal: "string",
        ratio: "string",
        resolveServerByDns: "string",
        rewriteHostHeader: "string",
        serverNode: "string",
        srvRdatas: [{
            port: "string",
            priority: "string",
            weight: "string",
        }],
        static: "string",
        verifyNetwork: "string",
        vmRef: "string",
    }],
    serviceMetadata: "string",
    sniEnabled: "string",
    spGsInfos: [{
        fqdns: ["string"],
        gsRef: "string",
    }],
    sslKeyAndCertificateRef: "string",
    sslProfileRef: "string",
    tenantRef: "string",
    tier1Lr: "string",
    useServicePort: "string",
    useServiceSslMode: "string",
    uuid: "string",
    vrfRef: "string",
});

    type: avi:Pool
properties:
    analyticsPolicies:
        - metricsRealtimeUpdates:
            - duration: string
              enabled: string
    analyticsProfileRef: string
    appendPort: string
    applicationPersistenceProfileRef: string
    autoscaleLaunchConfigRef: string
    autoscaleNetworks:
        - string
    autoscalePolicyRef: string
    capacityEstimation: string
    capacityEstimationTtfbThresh: string
    cloudConfigCksum: string
    cloudRef: string
    configpbAttributes:
        - version: string
    connPoolProperties:
        - upstreamConnpoolConnIdleTmo: string
          upstreamConnpoolConnLifeTmo: string
          upstreamConnpoolConnMaxReuse: string
          upstreamConnpoolServerMaxCache: string
    connectionRampDuration: string
    createdBy: string
    defaultServerPort: string
    deleteServerOnDnsRefresh: string
    description: string
    domainNames:
        - string
    eastWest: string
    enableHttp2: string
    enabled: string
    externalAutoscaleGroups:
        - string
    failActions:
        - localRsps:
            - files:
                - contentType: string
                  fileContent: string
                  fileLength: string
              statusCode: string
          redirects:
            - host: string
              path: string
              protocol: string
              query: string
              statusCode: string
          type: string
    fewestTasksFeedbackDelay: string
    gracefulDisableTimeout: string
    gracefulHmDownDisableTimeout: string
    gslbSpEnabled: string
    healthMonitorRefs:
        - string
    horizonProfiles:
        - blastPort: string
          pcoipPort: string
    hostCheckEnabled: string
    http2Properties:
        - maxHttp2ControlFramesPerConnection: string
          maxHttp2HeaderFieldSize: string
    ignoreServerPort: string
    ignoreServers: false
    inlineHealthMonitor: string
    ipaddrgroupRef: string
    lbAlgoRrPerSe: string
    lbAlgorithm: string
    lbAlgorithmConsistentHashHdr: string
    lbAlgorithmCoreNonaffinity: string
    lbAlgorithmHash: string
    lookupServerByName: string
    markers:
        - key: string
          values:
            - string
    maxConcurrentConnectionsPerServer: string
    maxConnRatePerServers:
        - actions:
            - files:
                - contentType: string
                  fileContent: string
                  fileLength: string
              redirects:
                - addString: string
                  hosts:
                    - tokens:
                        - endIndex: string
                          startIndex: string
                          strValue: string
                          type: string
                      type: string
                  keepQuery: string
                  paths:
                    - tokens:
                        - endIndex: string
                          startIndex: string
                          strValue: string
                          type: string
                      type: string
                  port: string
                  protocol: string
                  statusCode: string
              statusCode: string
              type: string
          explicitTracking: string
          fineGrain: string
          httpCookie: string
          httpHeader: string
          rateLimiters:
            - burstSz: string
              count: string
              name: string
              period: string
    minHealthMonitorsUp: string
    minServersUp: string
    name: string
    networks:
        - networkRef: string
          serverFilter: string
    nsxSecuritygroups:
        - string
    pkiProfileRef: string
    placementNetworks:
        - networkRef: string
          subnets:
            - ipAddrs:
                - addr: string
                  type: string
              mask: string
    poolId: string
    poolType: string
    requestQueueDepth: string
    requestQueueEnabled: string
    resolvePoolByDns: string
    rewriteHostHeaderToServerName: string
    rewriteHostHeaderToSni: string
    routingPool: string
    serverDisableType: string
    serverName: string
    serverReselects:
        - enabled: string
          numRetries: string
          retryNonidempotent: string
          retryTimeout: string
          svrRespCodes:
            - codes:
                - 0
              ranges:
                - begin: string
                  end: string
              respCodeBlocks:
                - string
    serverTimeout: string
    servers:
        - autoscalingGroupName: string
          availabilityZone: string
          description: string
          discoveredNetworks:
            - networkRef: string
              subnet6s:
                - ipAddrs:
                    - addr: string
                      type: string
                  mask: string
              subnets:
                - ipAddrs:
                    - addr: string
                      type: string
                  mask: string
          enabled: string
          externalOrchestrationId: string
          externalUuid: string
          healthMonitorRefs:
            - string
          hostname: string
          ips:
            - addr: string
              type: string
          locations:
            - latitude: string
              longitude: string
              name: string
              tag: string
          macAddress: string
          nwRef: string
          port: string
          preferenceOrder: string
          prstHdrVal: string
          ratio: string
          resolveServerByDns: string
          rewriteHostHeader: string
          serverNode: string
          srvRdatas:
            - port: string
              priority: string
              weight: string
          static: string
          verifyNetwork: string
          vmRef: string
    serviceMetadata: string
    sniEnabled: string
    spGsInfos:
        - fqdns:
            - string
          gsRef: string
    sslKeyAndCertificateRef: string
    sslProfileRef: string
    tenantRef: string
    tier1Lr: string
    useServicePort: string
    useServiceSslMode: string
    uuid: string
    vrfRef: string

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

    AnalyticsPolicies List<PoolAnalyticsPolicy>
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AnalyticsProfileRef string
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AppendPort string
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    ApplicationPersistenceProfileRef string
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AutoscaleLaunchConfigRef string
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    AutoscaleNetworks List<string>
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    AutoscalePolicyRef string
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    CapacityEstimation string
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    CapacityEstimationTtfbThresh string
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    CloudConfigCksum string
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CloudRef string
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<PoolConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConnPoolProperties List<PoolConnPoolProperty>
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConnectionRampDuration string
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    CreatedBy string
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DefaultServerPort string
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DeleteServerOnDnsRefresh string
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    Description string
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DomainNames List<string>
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EastWest string
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EnableHttp2 string
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ExternalAutoscaleGroups List<string>
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailActions List<PoolFailAction>
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FewestTasksFeedbackDelay string
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GracefulDisableTimeout string
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GracefulHmDownDisableTimeout string
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    GslbSpEnabled string
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    HealthMonitorRefs List<string>
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HorizonProfiles List<PoolHorizonProfile>
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    HostCheckEnabled string
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Http2Properties List<PoolHttp2Property>
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IgnoreServerPort string
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IgnoreServers bool
    InlineHealthMonitor string
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IpaddrgroupRef string
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LbAlgoRrPerSe string
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    LbAlgorithm string
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    LbAlgorithmConsistentHashHdr string
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LbAlgorithmCoreNonaffinity string
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    LbAlgorithmHash string
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    LookupServerByName string
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    Markers List<PoolMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxConcurrentConnectionsPerServer string
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxConnRatePerServers List<PoolMaxConnRatePerServer>
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    MinHealthMonitorsUp string
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    MinServersUp string
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Networks List<PoolNetwork>
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NsxSecuritygroups List<string>
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PkiProfileRef string
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PlacementNetworks List<PoolPlacementNetwork>
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PoolId string
    PoolType string
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RequestQueueDepth string
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    RequestQueueEnabled string
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    ResolvePoolByDns string
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RewriteHostHeaderToServerName string
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RewriteHostHeaderToSni string
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RoutingPool string
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerDisableType string
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ServerName string
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerReselects List<PoolServerReselect>
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerTimeout string
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Servers List<PoolServer>
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServiceMetadata string
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SniEnabled string
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SpGsInfos List<PoolSpGsInfo>
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SslKeyAndCertificateRef string
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SslProfileRef string
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Tier1Lr string
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UseServicePort string
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    UseServiceSslMode string
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    VrfRef string
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AnalyticsPolicies []PoolAnalyticsPolicyArgs
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AnalyticsProfileRef string
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AppendPort string
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    ApplicationPersistenceProfileRef string
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AutoscaleLaunchConfigRef string
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    AutoscaleNetworks []string
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    AutoscalePolicyRef string
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    CapacityEstimation string
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    CapacityEstimationTtfbThresh string
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    CloudConfigCksum string
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CloudRef string
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []PoolConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConnPoolProperties []PoolConnPoolPropertyArgs
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConnectionRampDuration string
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    CreatedBy string
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DefaultServerPort string
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DeleteServerOnDnsRefresh string
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    Description string
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DomainNames []string
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EastWest string
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EnableHttp2 string
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ExternalAutoscaleGroups []string
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailActions []PoolFailActionArgs
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FewestTasksFeedbackDelay string
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GracefulDisableTimeout string
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GracefulHmDownDisableTimeout string
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    GslbSpEnabled string
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    HealthMonitorRefs []string
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HorizonProfiles []PoolHorizonProfileArgs
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    HostCheckEnabled string
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Http2Properties []PoolHttp2PropertyArgs
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IgnoreServerPort string
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IgnoreServers bool
    InlineHealthMonitor string
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IpaddrgroupRef string
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LbAlgoRrPerSe string
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    LbAlgorithm string
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    LbAlgorithmConsistentHashHdr string
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LbAlgorithmCoreNonaffinity string
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    LbAlgorithmHash string
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    LookupServerByName string
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    Markers []PoolMarkerArgs
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxConcurrentConnectionsPerServer string
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxConnRatePerServers []PoolMaxConnRatePerServerArgs
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    MinHealthMonitorsUp string
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    MinServersUp string
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Networks []PoolNetworkArgs
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NsxSecuritygroups []string
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PkiProfileRef string
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PlacementNetworks []PoolPlacementNetworkArgs
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PoolId string
    PoolType string
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RequestQueueDepth string
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    RequestQueueEnabled string
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    ResolvePoolByDns string
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RewriteHostHeaderToServerName string
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RewriteHostHeaderToSni string
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RoutingPool string
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerDisableType string
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ServerName string
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerReselects []PoolServerReselectArgs
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerTimeout string
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Servers []PoolServerArgs
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServiceMetadata string
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SniEnabled string
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SpGsInfos []PoolSpGsInfoArgs
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SslKeyAndCertificateRef string
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SslProfileRef string
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Tier1Lr string
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UseServicePort string
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    UseServiceSslMode string
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    VrfRef string
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsPolicies List<PoolAnalyticsPolicy>
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsProfileRef String
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    appendPort String
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    applicationPersistenceProfileRef String
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoscaleLaunchConfigRef String
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscaleNetworks List<String>
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscalePolicyRef String
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    capacityEstimation String
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    capacityEstimationTtfbThresh String
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    cloudConfigCksum String
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudRef String
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<PoolConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connPoolProperties List<PoolConnPoolProperty>
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connectionRampDuration String
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    createdBy String
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    defaultServerPort String
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deleteServerOnDnsRefresh String
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    description String
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames List<String>
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    eastWest String
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enableHttp2 String
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    externalAutoscaleGroups List<String>
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failActions List<PoolFailAction>
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fewestTasksFeedbackDelay String
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulDisableTimeout String
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulHmDownDisableTimeout String
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    gslbSpEnabled String
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    healthMonitorRefs List<String>
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    horizonProfiles List<PoolHorizonProfile>
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    hostCheckEnabled String
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    http2Properties List<PoolHttp2Property>
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServerPort String
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServers Boolean
    inlineHealthMonitor String
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ipaddrgroupRef String
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgoRrPerSe String
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    lbAlgorithm String
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    lbAlgorithmConsistentHashHdr String
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgorithmCoreNonaffinity String
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    lbAlgorithmHash String
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    lookupServerByName String
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    markers List<PoolMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConcurrentConnectionsPerServer String
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConnRatePerServers List<PoolMaxConnRatePerServer>
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    minHealthMonitorsUp String
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    minServersUp String
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    networks List<PoolNetwork>
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    nsxSecuritygroups List<String>
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef String
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    placementNetworks List<PoolPlacementNetwork>
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    poolId String
    poolType String
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    requestQueueDepth String
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    requestQueueEnabled String
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    resolvePoolByDns String
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToServerName String
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToSni String
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    routingPool String
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverDisableType String
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    serverName String
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverReselects List<PoolServerReselect>
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverTimeout String
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    servers List<PoolServer>
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceMetadata String
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sniEnabled String
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    spGsInfos List<PoolSpGsInfo>
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslKeyAndCertificateRef String
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslProfileRef String
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tier1Lr String
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useServicePort String
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    useServiceSslMode String
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfRef String
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsPolicies PoolAnalyticsPolicy[]
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsProfileRef string
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    appendPort string
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    applicationPersistenceProfileRef string
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoscaleLaunchConfigRef string
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscaleNetworks string[]
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscalePolicyRef string
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    capacityEstimation string
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    capacityEstimationTtfbThresh string
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    cloudConfigCksum string
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudRef string
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes PoolConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connPoolProperties PoolConnPoolProperty[]
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connectionRampDuration string
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    createdBy string
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    defaultServerPort string
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deleteServerOnDnsRefresh string
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    description string
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames string[]
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    eastWest string
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enableHttp2 string
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    externalAutoscaleGroups string[]
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failActions PoolFailAction[]
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fewestTasksFeedbackDelay string
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulDisableTimeout string
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulHmDownDisableTimeout string
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    gslbSpEnabled string
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    healthMonitorRefs string[]
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    horizonProfiles PoolHorizonProfile[]
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    hostCheckEnabled string
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    http2Properties PoolHttp2Property[]
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServerPort string
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServers boolean
    inlineHealthMonitor string
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ipaddrgroupRef string
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgoRrPerSe string
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    lbAlgorithm string
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    lbAlgorithmConsistentHashHdr string
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgorithmCoreNonaffinity string
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    lbAlgorithmHash string
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    lookupServerByName string
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    markers PoolMarker[]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConcurrentConnectionsPerServer string
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConnRatePerServers PoolMaxConnRatePerServer[]
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    minHealthMonitorsUp string
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    minServersUp string
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    networks PoolNetwork[]
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    nsxSecuritygroups string[]
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef string
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    placementNetworks PoolPlacementNetwork[]
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    poolId string
    poolType string
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    requestQueueDepth string
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    requestQueueEnabled string
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    resolvePoolByDns string
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToServerName string
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToSni string
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    routingPool string
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverDisableType string
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    serverName string
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverReselects PoolServerReselect[]
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverTimeout string
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    servers PoolServer[]
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceMetadata string
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sniEnabled string
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    spGsInfos PoolSpGsInfo[]
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslKeyAndCertificateRef string
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslProfileRef string
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tier1Lr string
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useServicePort string
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    useServiceSslMode string
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfRef string
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analytics_policies Sequence[PoolAnalyticsPolicyArgs]
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analytics_profile_ref str
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    append_port str
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    application_persistence_profile_ref str
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoscale_launch_config_ref str
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscale_networks Sequence[str]
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscale_policy_ref str
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    capacity_estimation str
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    capacity_estimation_ttfb_thresh str
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    cloud_config_cksum str
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloud_ref str
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[PoolConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    conn_pool_properties Sequence[PoolConnPoolPropertyArgs]
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connection_ramp_duration str
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    created_by str
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    default_server_port str
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    delete_server_on_dns_refresh str
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    description str
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domain_names Sequence[str]
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    east_west str
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enable_http2 str
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    enabled str
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    external_autoscale_groups Sequence[str]
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fail_actions Sequence[PoolFailActionArgs]
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fewest_tasks_feedback_delay str
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    graceful_disable_timeout str
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    graceful_hm_down_disable_timeout str
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    gslb_sp_enabled str
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    health_monitor_refs Sequence[str]
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    horizon_profiles Sequence[PoolHorizonProfileArgs]
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    host_check_enabled str
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    http2_properties Sequence[PoolHttp2PropertyArgs]
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignore_server_port str
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignore_servers bool
    inline_health_monitor str
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ipaddrgroup_ref str
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lb_algo_rr_per_se str
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    lb_algorithm str
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    lb_algorithm_consistent_hash_hdr str
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lb_algorithm_core_nonaffinity str
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    lb_algorithm_hash str
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    lookup_server_by_name str
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    markers Sequence[PoolMarkerArgs]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_concurrent_connections_per_server str
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_conn_rate_per_servers Sequence[PoolMaxConnRatePerServerArgs]
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    min_health_monitors_up str
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    min_servers_up str
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    networks Sequence[PoolNetworkArgs]
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    nsx_securitygroups Sequence[str]
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pki_profile_ref str
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    placement_networks Sequence[PoolPlacementNetworkArgs]
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pool_id str
    pool_type str
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    request_queue_depth str
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    request_queue_enabled str
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    resolve_pool_by_dns str
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewrite_host_header_to_server_name str
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewrite_host_header_to_sni str
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    routing_pool str
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    server_disable_type str
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    server_name str
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    server_reselects Sequence[PoolServerReselectArgs]
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    server_timeout str
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    servers Sequence[PoolServerArgs]
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    service_metadata str
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sni_enabled str
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sp_gs_infos Sequence[PoolSpGsInfoArgs]
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ssl_key_and_certificate_ref str
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ssl_profile_ref str
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tier1_lr str
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    use_service_port str
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    use_service_ssl_mode str
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrf_ref str
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsPolicies List<Property Map>
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsProfileRef String
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    appendPort String
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    applicationPersistenceProfileRef String
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoscaleLaunchConfigRef String
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscaleNetworks List<String>
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscalePolicyRef String
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    capacityEstimation String
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    capacityEstimationTtfbThresh String
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    cloudConfigCksum String
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudRef String
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connPoolProperties List<Property Map>
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connectionRampDuration String
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    createdBy String
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    defaultServerPort String
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deleteServerOnDnsRefresh String
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    description String
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames List<String>
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    eastWest String
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enableHttp2 String
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    externalAutoscaleGroups List<String>
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failActions List<Property Map>
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fewestTasksFeedbackDelay String
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulDisableTimeout String
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulHmDownDisableTimeout String
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    gslbSpEnabled String
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    healthMonitorRefs List<String>
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    horizonProfiles List<Property Map>
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    hostCheckEnabled String
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    http2Properties List<Property Map>
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServerPort String
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServers Boolean
    inlineHealthMonitor String
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ipaddrgroupRef String
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgoRrPerSe String
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    lbAlgorithm String
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    lbAlgorithmConsistentHashHdr String
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgorithmCoreNonaffinity String
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    lbAlgorithmHash String
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    lookupServerByName String
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    markers List<Property Map>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConcurrentConnectionsPerServer String
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConnRatePerServers List<Property Map>
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    minHealthMonitorsUp String
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    minServersUp String
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    networks List<Property Map>
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    nsxSecuritygroups List<String>
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef String
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    placementNetworks List<Property Map>
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    poolId String
    poolType String
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    requestQueueDepth String
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    requestQueueEnabled String
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    resolvePoolByDns String
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToServerName String
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToSni String
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    routingPool String
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverDisableType String
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    serverName String
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverReselects List<Property Map>
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverTimeout String
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    servers List<Property Map>
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceMetadata String
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sniEnabled String
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    spGsInfos List<Property Map>
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslKeyAndCertificateRef String
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslProfileRef String
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tier1Lr String
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useServicePort String
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    useServiceSslMode String
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfRef String
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Pool Resource

    Get an existing Pool 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?: PoolState, opts?: CustomResourceOptions): Pool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        analytics_policies: Optional[Sequence[PoolAnalyticsPolicyArgs]] = None,
        analytics_profile_ref: Optional[str] = None,
        append_port: Optional[str] = None,
        application_persistence_profile_ref: Optional[str] = None,
        autoscale_launch_config_ref: Optional[str] = None,
        autoscale_networks: Optional[Sequence[str]] = None,
        autoscale_policy_ref: Optional[str] = None,
        capacity_estimation: Optional[str] = None,
        capacity_estimation_ttfb_thresh: Optional[str] = None,
        cloud_config_cksum: Optional[str] = None,
        cloud_ref: Optional[str] = None,
        configpb_attributes: Optional[Sequence[PoolConfigpbAttributeArgs]] = None,
        conn_pool_properties: Optional[Sequence[PoolConnPoolPropertyArgs]] = None,
        connection_ramp_duration: Optional[str] = None,
        created_by: Optional[str] = None,
        default_server_port: Optional[str] = None,
        delete_server_on_dns_refresh: Optional[str] = None,
        description: Optional[str] = None,
        domain_names: Optional[Sequence[str]] = None,
        east_west: Optional[str] = None,
        enable_http2: Optional[str] = None,
        enabled: Optional[str] = None,
        external_autoscale_groups: Optional[Sequence[str]] = None,
        fail_actions: Optional[Sequence[PoolFailActionArgs]] = None,
        fewest_tasks_feedback_delay: Optional[str] = None,
        graceful_disable_timeout: Optional[str] = None,
        graceful_hm_down_disable_timeout: Optional[str] = None,
        gslb_sp_enabled: Optional[str] = None,
        health_monitor_refs: Optional[Sequence[str]] = None,
        horizon_profiles: Optional[Sequence[PoolHorizonProfileArgs]] = None,
        host_check_enabled: Optional[str] = None,
        http2_properties: Optional[Sequence[PoolHttp2PropertyArgs]] = None,
        ignore_server_port: Optional[str] = None,
        ignore_servers: Optional[bool] = None,
        inline_health_monitor: Optional[str] = None,
        ipaddrgroup_ref: Optional[str] = None,
        lb_algo_rr_per_se: Optional[str] = None,
        lb_algorithm: Optional[str] = None,
        lb_algorithm_consistent_hash_hdr: Optional[str] = None,
        lb_algorithm_core_nonaffinity: Optional[str] = None,
        lb_algorithm_hash: Optional[str] = None,
        lookup_server_by_name: Optional[str] = None,
        markers: Optional[Sequence[PoolMarkerArgs]] = None,
        max_concurrent_connections_per_server: Optional[str] = None,
        max_conn_rate_per_servers: Optional[Sequence[PoolMaxConnRatePerServerArgs]] = None,
        min_health_monitors_up: Optional[str] = None,
        min_servers_up: Optional[str] = None,
        name: Optional[str] = None,
        networks: Optional[Sequence[PoolNetworkArgs]] = None,
        nsx_securitygroups: Optional[Sequence[str]] = None,
        pki_profile_ref: Optional[str] = None,
        placement_networks: Optional[Sequence[PoolPlacementNetworkArgs]] = None,
        pool_id: Optional[str] = None,
        pool_type: Optional[str] = None,
        request_queue_depth: Optional[str] = None,
        request_queue_enabled: Optional[str] = None,
        resolve_pool_by_dns: Optional[str] = None,
        rewrite_host_header_to_server_name: Optional[str] = None,
        rewrite_host_header_to_sni: Optional[str] = None,
        routing_pool: Optional[str] = None,
        server_disable_type: Optional[str] = None,
        server_name: Optional[str] = None,
        server_reselects: Optional[Sequence[PoolServerReselectArgs]] = None,
        server_timeout: Optional[str] = None,
        servers: Optional[Sequence[PoolServerArgs]] = None,
        service_metadata: Optional[str] = None,
        sni_enabled: Optional[str] = None,
        sp_gs_infos: Optional[Sequence[PoolSpGsInfoArgs]] = None,
        ssl_key_and_certificate_ref: Optional[str] = None,
        ssl_profile_ref: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        tier1_lr: Optional[str] = None,
        use_service_port: Optional[str] = None,
        use_service_ssl_mode: Optional[str] = None,
        uuid: Optional[str] = None,
        vrf_ref: Optional[str] = None) -> Pool
    func GetPool(ctx *Context, name string, id IDInput, state *PoolState, opts ...ResourceOption) (*Pool, error)
    public static Pool Get(string name, Input<string> id, PoolState? state, CustomResourceOptions? opts = null)
    public static Pool get(String name, Output<String> id, PoolState state, CustomResourceOptions options)
    resources:  _:    type: avi:Pool    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AnalyticsPolicies List<PoolAnalyticsPolicy>
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AnalyticsProfileRef string
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AppendPort string
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    ApplicationPersistenceProfileRef string
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AutoscaleLaunchConfigRef string
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    AutoscaleNetworks List<string>
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    AutoscalePolicyRef string
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    CapacityEstimation string
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    CapacityEstimationTtfbThresh string
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    CloudConfigCksum string
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CloudRef string
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<PoolConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConnPoolProperties List<PoolConnPoolProperty>
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConnectionRampDuration string
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    CreatedBy string
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DefaultServerPort string
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DeleteServerOnDnsRefresh string
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    Description string
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DomainNames List<string>
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EastWest string
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EnableHttp2 string
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ExternalAutoscaleGroups List<string>
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailActions List<PoolFailAction>
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FewestTasksFeedbackDelay string
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GracefulDisableTimeout string
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GracefulHmDownDisableTimeout string
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    GslbSpEnabled string
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    HealthMonitorRefs List<string>
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HorizonProfiles List<PoolHorizonProfile>
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    HostCheckEnabled string
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Http2Properties List<PoolHttp2Property>
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IgnoreServerPort string
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IgnoreServers bool
    InlineHealthMonitor string
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IpaddrgroupRef string
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LbAlgoRrPerSe string
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    LbAlgorithm string
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    LbAlgorithmConsistentHashHdr string
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LbAlgorithmCoreNonaffinity string
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    LbAlgorithmHash string
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    LookupServerByName string
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    Markers List<PoolMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxConcurrentConnectionsPerServer string
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxConnRatePerServers List<PoolMaxConnRatePerServer>
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    MinHealthMonitorsUp string
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    MinServersUp string
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Networks List<PoolNetwork>
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NsxSecuritygroups List<string>
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PkiProfileRef string
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PlacementNetworks List<PoolPlacementNetwork>
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PoolId string
    PoolType string
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RequestQueueDepth string
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    RequestQueueEnabled string
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    ResolvePoolByDns string
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RewriteHostHeaderToServerName string
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RewriteHostHeaderToSni string
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RoutingPool string
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerDisableType string
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ServerName string
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerReselects List<PoolServerReselect>
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerTimeout string
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Servers List<PoolServer>
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServiceMetadata string
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SniEnabled string
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SpGsInfos List<PoolSpGsInfo>
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SslKeyAndCertificateRef string
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SslProfileRef string
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Tier1Lr string
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UseServicePort string
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    UseServiceSslMode string
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    VrfRef string
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AnalyticsPolicies []PoolAnalyticsPolicyArgs
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AnalyticsProfileRef string
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AppendPort string
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    ApplicationPersistenceProfileRef string
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AutoscaleLaunchConfigRef string
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    AutoscaleNetworks []string
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    AutoscalePolicyRef string
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    CapacityEstimation string
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    CapacityEstimationTtfbThresh string
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    CloudConfigCksum string
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CloudRef string
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []PoolConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConnPoolProperties []PoolConnPoolPropertyArgs
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConnectionRampDuration string
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    CreatedBy string
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DefaultServerPort string
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DeleteServerOnDnsRefresh string
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    Description string
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DomainNames []string
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EastWest string
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EnableHttp2 string
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ExternalAutoscaleGroups []string
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FailActions []PoolFailActionArgs
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FewestTasksFeedbackDelay string
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GracefulDisableTimeout string
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    GracefulHmDownDisableTimeout string
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    GslbSpEnabled string
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    HealthMonitorRefs []string
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    HorizonProfiles []PoolHorizonProfileArgs
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    HostCheckEnabled string
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Http2Properties []PoolHttp2PropertyArgs
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IgnoreServerPort string
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IgnoreServers bool
    InlineHealthMonitor string
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    IpaddrgroupRef string
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LbAlgoRrPerSe string
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    LbAlgorithm string
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    LbAlgorithmConsistentHashHdr string
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LbAlgorithmCoreNonaffinity string
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    LbAlgorithmHash string
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    LookupServerByName string
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    Markers []PoolMarkerArgs
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxConcurrentConnectionsPerServer string
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxConnRatePerServers []PoolMaxConnRatePerServerArgs
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    MinHealthMonitorsUp string
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    MinServersUp string
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Networks []PoolNetworkArgs
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NsxSecuritygroups []string
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PkiProfileRef string
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PlacementNetworks []PoolPlacementNetworkArgs
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    PoolId string
    PoolType string
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RequestQueueDepth string
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    RequestQueueEnabled string
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    ResolvePoolByDns string
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RewriteHostHeaderToServerName string
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RewriteHostHeaderToSni string
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RoutingPool string
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerDisableType string
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    ServerName string
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerReselects []PoolServerReselectArgs
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServerTimeout string
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Servers []PoolServerArgs
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ServiceMetadata string
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SniEnabled string
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SpGsInfos []PoolSpGsInfoArgs
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SslKeyAndCertificateRef string
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SslProfileRef string
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Tier1Lr string
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UseServicePort string
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    UseServiceSslMode string
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    VrfRef string
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsPolicies List<PoolAnalyticsPolicy>
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsProfileRef String
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    appendPort String
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    applicationPersistenceProfileRef String
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoscaleLaunchConfigRef String
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscaleNetworks List<String>
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscalePolicyRef String
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    capacityEstimation String
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    capacityEstimationTtfbThresh String
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    cloudConfigCksum String
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudRef String
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<PoolConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connPoolProperties List<PoolConnPoolProperty>
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connectionRampDuration String
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    createdBy String
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    defaultServerPort String
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deleteServerOnDnsRefresh String
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    description String
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames List<String>
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    eastWest String
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enableHttp2 String
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    externalAutoscaleGroups List<String>
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failActions List<PoolFailAction>
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fewestTasksFeedbackDelay String
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulDisableTimeout String
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulHmDownDisableTimeout String
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    gslbSpEnabled String
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    healthMonitorRefs List<String>
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    horizonProfiles List<PoolHorizonProfile>
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    hostCheckEnabled String
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    http2Properties List<PoolHttp2Property>
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServerPort String
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServers Boolean
    inlineHealthMonitor String
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ipaddrgroupRef String
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgoRrPerSe String
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    lbAlgorithm String
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    lbAlgorithmConsistentHashHdr String
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgorithmCoreNonaffinity String
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    lbAlgorithmHash String
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    lookupServerByName String
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    markers List<PoolMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConcurrentConnectionsPerServer String
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConnRatePerServers List<PoolMaxConnRatePerServer>
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    minHealthMonitorsUp String
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    minServersUp String
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    networks List<PoolNetwork>
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    nsxSecuritygroups List<String>
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef String
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    placementNetworks List<PoolPlacementNetwork>
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    poolId String
    poolType String
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    requestQueueDepth String
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    requestQueueEnabled String
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    resolvePoolByDns String
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToServerName String
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToSni String
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    routingPool String
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverDisableType String
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    serverName String
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverReselects List<PoolServerReselect>
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverTimeout String
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    servers List<PoolServer>
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceMetadata String
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sniEnabled String
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    spGsInfos List<PoolSpGsInfo>
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslKeyAndCertificateRef String
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslProfileRef String
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tier1Lr String
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useServicePort String
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    useServiceSslMode String
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfRef String
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsPolicies PoolAnalyticsPolicy[]
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsProfileRef string
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    appendPort string
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    applicationPersistenceProfileRef string
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoscaleLaunchConfigRef string
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscaleNetworks string[]
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscalePolicyRef string
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    capacityEstimation string
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    capacityEstimationTtfbThresh string
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    cloudConfigCksum string
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudRef string
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes PoolConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connPoolProperties PoolConnPoolProperty[]
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connectionRampDuration string
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    createdBy string
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    defaultServerPort string
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deleteServerOnDnsRefresh string
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    description string
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames string[]
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    eastWest string
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enableHttp2 string
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    externalAutoscaleGroups string[]
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failActions PoolFailAction[]
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fewestTasksFeedbackDelay string
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulDisableTimeout string
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulHmDownDisableTimeout string
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    gslbSpEnabled string
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    healthMonitorRefs string[]
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    horizonProfiles PoolHorizonProfile[]
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    hostCheckEnabled string
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    http2Properties PoolHttp2Property[]
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServerPort string
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServers boolean
    inlineHealthMonitor string
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ipaddrgroupRef string
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgoRrPerSe string
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    lbAlgorithm string
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    lbAlgorithmConsistentHashHdr string
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgorithmCoreNonaffinity string
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    lbAlgorithmHash string
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    lookupServerByName string
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    markers PoolMarker[]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConcurrentConnectionsPerServer string
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConnRatePerServers PoolMaxConnRatePerServer[]
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    minHealthMonitorsUp string
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    minServersUp string
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    networks PoolNetwork[]
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    nsxSecuritygroups string[]
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef string
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    placementNetworks PoolPlacementNetwork[]
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    poolId string
    poolType string
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    requestQueueDepth string
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    requestQueueEnabled string
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    resolvePoolByDns string
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToServerName string
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToSni string
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    routingPool string
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverDisableType string
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    serverName string
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverReselects PoolServerReselect[]
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverTimeout string
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    servers PoolServer[]
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceMetadata string
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sniEnabled string
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    spGsInfos PoolSpGsInfo[]
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslKeyAndCertificateRef string
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslProfileRef string
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tier1Lr string
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useServicePort string
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    useServiceSslMode string
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfRef string
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analytics_policies Sequence[PoolAnalyticsPolicyArgs]
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analytics_profile_ref str
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    append_port str
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    application_persistence_profile_ref str
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoscale_launch_config_ref str
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscale_networks Sequence[str]
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscale_policy_ref str
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    capacity_estimation str
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    capacity_estimation_ttfb_thresh str
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    cloud_config_cksum str
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloud_ref str
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[PoolConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    conn_pool_properties Sequence[PoolConnPoolPropertyArgs]
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connection_ramp_duration str
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    created_by str
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    default_server_port str
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    delete_server_on_dns_refresh str
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    description str
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domain_names Sequence[str]
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    east_west str
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enable_http2 str
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    enabled str
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    external_autoscale_groups Sequence[str]
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fail_actions Sequence[PoolFailActionArgs]
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fewest_tasks_feedback_delay str
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    graceful_disable_timeout str
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    graceful_hm_down_disable_timeout str
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    gslb_sp_enabled str
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    health_monitor_refs Sequence[str]
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    horizon_profiles Sequence[PoolHorizonProfileArgs]
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    host_check_enabled str
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    http2_properties Sequence[PoolHttp2PropertyArgs]
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignore_server_port str
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignore_servers bool
    inline_health_monitor str
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ipaddrgroup_ref str
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lb_algo_rr_per_se str
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    lb_algorithm str
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    lb_algorithm_consistent_hash_hdr str
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lb_algorithm_core_nonaffinity str
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    lb_algorithm_hash str
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    lookup_server_by_name str
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    markers Sequence[PoolMarkerArgs]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_concurrent_connections_per_server str
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_conn_rate_per_servers Sequence[PoolMaxConnRatePerServerArgs]
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    min_health_monitors_up str
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    min_servers_up str
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    networks Sequence[PoolNetworkArgs]
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    nsx_securitygroups Sequence[str]
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pki_profile_ref str
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    placement_networks Sequence[PoolPlacementNetworkArgs]
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pool_id str
    pool_type str
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    request_queue_depth str
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    request_queue_enabled str
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    resolve_pool_by_dns str
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewrite_host_header_to_server_name str
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewrite_host_header_to_sni str
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    routing_pool str
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    server_disable_type str
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    server_name str
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    server_reselects Sequence[PoolServerReselectArgs]
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    server_timeout str
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    servers Sequence[PoolServerArgs]
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    service_metadata str
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sni_enabled str
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sp_gs_infos Sequence[PoolSpGsInfoArgs]
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ssl_key_and_certificate_ref str
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ssl_profile_ref str
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tier1_lr str
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    use_service_port str
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    use_service_ssl_mode str
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrf_ref str
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsPolicies List<Property Map>
    Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    analyticsProfileRef String
    Specifies settings related to analytics. It is a reference to an object of type analyticsprofile. Field introduced in 18.1.4,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    appendPort String
    Allows the option to append port to hostname in the host header while sending a request to the server. By default, port is appended for non-default ports. This setting will apply for pool's 'rewrite host header to server name', 'rewrite host header to sni' features and server's 'rewrite host header' settings as well as http healthmonitors attached to pools. Enum options - NON_DEFAULT_80_443, NEVER, ALWAYS. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- never), basic (allowed values- never) edition. Special default for essentials edition is never, basic edition is never, enterprise edition is non_default_80_443.
    applicationPersistenceProfileRef String
    Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type applicationpersistenceprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    autoscaleLaunchConfigRef String
    If configured then avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type autoscalelaunchconfig. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscaleNetworks List<String>
    Network ids for the launch configuration. Allowed with any value in enterprise, enterprise with cloud services edition.
    autoscalePolicyRef String
    Reference to server autoscale policy. It is a reference to an object of type serverautoscalepolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
    capacityEstimation String
    Inline estimation of capacity of servers. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    capacityEstimationTtfbThresh String
    The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - automatic. Unit is milliseconds. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
    cloudConfigCksum String
    Checksum of cloud configuration for pool. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    cloudRef String
    It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connPoolProperties List<Property Map>
    Connnection pool properties. Field introduced in 18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    connectionRampDuration String
    Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for lb algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - immediate. Unit is min. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition. Special default for essentials edition is 0, basic edition is 0, enterprise edition is 10.
    createdBy String
    Creator name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    defaultServerPort String
    Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The ssl checkbox enables avi to server encryption. Allowed values are 1-65535. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    deleteServerOnDnsRefresh String
    Indicates whether existing ips are disabled(false) or deleted(true) on dns hostname refreshdetail -- on a dns refresh, some ips set on pool may no longer be returned by the resolver. These ips are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- true), basic (allowed values- true) edition.
    description String
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    domainNames List<String>
    Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    eastWest String
    Inherited config from virtualservice. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enableHttp2 String
    Enable http/2 for traffic from virtualservice to all backend servers in this pool. Field introduced in 20.1.1. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    externalAutoscaleGroups List<String>
    Names of external auto-scale groups for pool servers. Currently available only for aws and azure. Field introduced in 17.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    failActions List<Property Map>
    Enable an action - close connection, http redirect or local http response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    fewestTasksFeedbackDelay String
    Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is sec. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulDisableTimeout String
    Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - immediate, -1 - infinite. Unit is min. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    gracefulHmDownDisableTimeout String
    Time interval for gracefully closing the connections on server, when health monitoring marks the server down. Allowed values are 1-432000. Special values are 0 - immediate, -1 - infinite. Field introduced in 30.2.1. Unit is sec. Allowed with any value in enterprise, enterprise with cloud services edition.
    gslbSpEnabled String
    Indicates if the pool is a site-persistence pool. Field introduced in 17.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    healthMonitorRefs List<String>
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    horizonProfiles List<Property Map>
    Horizon uag configuration. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    hostCheckEnabled String
    Enable common name check for server certificate. If enabled and no explicit domain name is specified, avi will use the incoming host header to do the match. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    http2Properties List<Property Map>
    Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServerPort String
    Ignore the server port in building the load balancing state.applicable only for consistent hash load balancing algorithm or disable port translation (use_service_port) use cases. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ignoreServers Boolean
    inlineHealthMonitor String
    The passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the lb method, such as round robin. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ipaddrgroupRef String
    Use list of servers from ip address group. It is a reference to an object of type ipaddrgroup. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgoRrPerSe String
    Do load balancing at se level instead of the default per core load balancing. Field introduced in 21.1.5, 22.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
    lbAlgorithm String
    The load balancing algorithm will pick a server within the pool's list of available servers. Values lb_algorithm_nearest_server and lb_algorithm_topology are only allowed for gslb pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash), basic (allowed values- lb_algorithm_least_connections,lb_algorithm_round_robin,lb_algorithm_consistent_hash) edition.
    lbAlgorithmConsistentHashHdr String
    Http header name to be used for the hash key. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    lbAlgorithmCoreNonaffinity String
    Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 2), basic (allowed values- 2) edition.
    lbAlgorithmHash String
    Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- lb_algorithm_consistent_hash_source_ip_address), basic (allowed values- lb_algorithm_consistent_hash_source_ip_address) edition.
    lookupServerByName String
    Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    markers List<Property Map>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConcurrentConnectionsPerServer String
    The maximum number of concurrent connections allowed to each server within the pool. Note applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxConnRatePerServers List<Property Map>
    Rate limit connections to each server. Allowed with any value in enterprise, enterprise with cloud services edition.
    minHealthMonitorsUp String
    Minimum number of health monitors in up state to mark server up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, enterprise with cloud services edition.
    minServersUp String
    Minimum number of servers in up state for marking the pool up. Field introduced in 18.2.1, 17.2.12. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    networks List<Property Map>
    (internal-use) networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by avi, not editable by the user. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    nsxSecuritygroups List<String>
    A list of nsx groups where the servers for the pool are created. Field introduced in 17.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    pkiProfileRef String
    Avi will validate the ssl certificate present by a server against the selected pki profile. It is a reference to an object of type pkiprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    placementNetworks List<Property Map>
    Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the subnet using the following syntax 10-1-1-0/24. Use static routes in vrf configuration when pool servers are not directly connected but routable from the service engine. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    poolId String
    poolType String
    Type or purpose, the pool is to be used for. Enum options - POOL_TYPE_GENERIC_APP, POOL_TYPE_OAUTH. Field introduced in 22.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    requestQueueDepth String
    Minimum number of requests to be queued when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 128), basic (allowed values- 128) edition.
    requestQueueEnabled String
    Enable request queue when pool is full. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
    resolvePoolByDns String
    This field is used as a flag to create a job for jobmanager. Field introduced in 18.2.10,20.1.2. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToServerName String
    Rewrite incoming host header to server name of the server to which the request is proxied. Enabling this feature rewrites host header for requests to all servers in the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    rewriteHostHeaderToSni String
    If sni server name is specified, rewrite incoming host header to the sni server name. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    routingPool String
    Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverDisableType String
    Server graceful disable timeout behaviour. Enum options - DISALLOW_NEW_CONNECTION, ALLOW_NEW_CONNECTION_IF_PERSISTENCE_PRESENT. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    serverName String
    Fully qualified dns hostname which will be used in the tls sni extension in server connections if sni is enabled. If no value is specified, avi will use the incoming host header instead. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverReselects List<Property Map>
    Server reselect configuration for http requests. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serverTimeout String
    Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between avi and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-21600000. Field introduced in 18.1.5,18.2.1. Unit is milliseconds. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    servers List<Property Map>
    The pool directs load balanced traffic to this list of destination servers. The servers can be configured by ip address, name, network or via ip address group. Maximum of 5000 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    serviceMetadata String
    Metadata pertaining to the service provided by this pool. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sniEnabled String
    Enable tls sni for server connections. If disabled, avi will not send the sni extension as part of the handshake. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    spGsInfos List<Property Map>
    Gslb service associated with the site persistence pool. Field introduced in 22.1.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslKeyAndCertificateRef String
    Service engines will present a client ssl certificate to the server. It is a reference to an object of type sslkeyandcertificate. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    sslProfileRef String
    When enabled, avi re-encrypts traffic to the backend servers. The specific ssl profile defines which ciphers and ssl versions will be supported. It is a reference to an object of type sslprofile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tier1Lr String
    This tier1_lr field should be set same as virtualservice associated for nsx-t. Field introduced in 20.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    useServicePort String
    Do not translate the client's destination port when sending the connection to the server. Monitor port needs to be specified for health monitors. Allowed with any value in enterprise, basic, enterprise with cloud services edition. Allowed in essentials (allowed values- false) edition.
    useServiceSslMode String
    This applies only when use_service_port is set to true. If enabled, ssl mode of the connection to the server is decided by the ssl mode on the virtualservice service port, on which the request was received. Field introduced in 21.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    vrfRef String
    Virtual routing context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the virtual routing context of the virtual service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type vrfcontext. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Supporting Types

    PoolAnalyticsPolicy, PoolAnalyticsPolicyArgs

    PoolAnalyticsPolicyMetricsRealtimeUpdate, PoolAnalyticsPolicyMetricsRealtimeUpdateArgs

    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Duration string
    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Duration string
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    duration String
    enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    duration string
    enabled str
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    duration str
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    duration String

    PoolConfigpbAttribute, PoolConfigpbAttributeArgs

    Version string
    Version string
    version String
    version string
    version String

    PoolConnPoolProperty, PoolConnPoolPropertyArgs

    PoolFailAction, PoolFailActionArgs

    PoolFailActionLocalRsp, PoolFailActionLocalRspArgs

    PoolFailActionLocalRspFile, PoolFailActionLocalRspFileArgs

    PoolFailActionRedirect, PoolFailActionRedirectArgs

    Host string
    Path string
    Protocol string
    Query string
    StatusCode string
    Host string
    Path string
    Protocol string
    Query string
    StatusCode string
    host String
    path String
    protocol String
    query String
    statusCode String
    host string
    path string
    protocol string
    query string
    statusCode string
    host String
    path String
    protocol String
    query String
    statusCode String

    PoolHorizonProfile, PoolHorizonProfileArgs

    BlastPort string
    PcoipPort string
    BlastPort string
    PcoipPort string
    blastPort String
    pcoipPort String
    blastPort string
    pcoipPort string
    blastPort String
    pcoipPort String

    PoolHttp2Property, PoolHttp2PropertyArgs

    PoolMarker, PoolMarkerArgs

    Key string
    Values List<string>
    Key string
    Values []string
    key String
    values List<String>
    key string
    values string[]
    key str
    values Sequence[str]
    key String
    values List<String>

    PoolMaxConnRatePerServer, PoolMaxConnRatePerServerArgs

    PoolMaxConnRatePerServerAction, PoolMaxConnRatePerServerActionArgs

    PoolMaxConnRatePerServerActionFile, PoolMaxConnRatePerServerActionFileArgs

    PoolMaxConnRatePerServerActionRedirect, PoolMaxConnRatePerServerActionRedirectArgs

    PoolMaxConnRatePerServerActionRedirectHost, PoolMaxConnRatePerServerActionRedirectHostArgs

    PoolMaxConnRatePerServerActionRedirectHostToken, PoolMaxConnRatePerServerActionRedirectHostTokenArgs

    Type string
    EndIndex string
    StartIndex string
    StrValue string
    Type string
    EndIndex string
    StartIndex string
    StrValue string
    type String
    endIndex String
    startIndex String
    strValue String
    type string
    endIndex string
    startIndex string
    strValue string
    type String
    endIndex String
    startIndex String
    strValue String

    PoolMaxConnRatePerServerActionRedirectPath, PoolMaxConnRatePerServerActionRedirectPathArgs

    PoolMaxConnRatePerServerActionRedirectPathToken, PoolMaxConnRatePerServerActionRedirectPathTokenArgs

    Type string
    EndIndex string
    StartIndex string
    StrValue string
    Type string
    EndIndex string
    StartIndex string
    StrValue string
    type String
    endIndex String
    startIndex String
    strValue String
    type string
    endIndex string
    startIndex string
    strValue string
    type String
    endIndex String
    startIndex String
    strValue String

    PoolMaxConnRatePerServerRateLimiter, PoolMaxConnRatePerServerRateLimiterArgs

    BurstSz string
    Count string
    Name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Period string
    BurstSz string
    Count string
    Name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Period string
    burstSz String
    count String
    name String
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    period String
    burstSz string
    count string
    name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    period string
    burst_sz str
    count str
    name str
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    period str
    burstSz String
    count String
    name String
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    period String

    PoolNetwork, PoolNetworkArgs

    PoolPlacementNetwork, PoolPlacementNetworkArgs

    PoolPlacementNetworkSubnet, PoolPlacementNetworkSubnetArgs

    PoolPlacementNetworkSubnetIpAddr, PoolPlacementNetworkSubnetIpAddrArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    PoolServer, PoolServerArgs

    Ips List<PoolServerIp>
    AutoscalingGroupName string
    AvailabilityZone string
    Description string
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DiscoveredNetworks List<PoolServerDiscoveredNetwork>
    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ExternalOrchestrationId string
    ExternalUuid string
    HealthMonitorRefs List<string>
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Hostname string
    Locations List<PoolServerLocation>
    MacAddress string
    NwRef string
    Port string
    PreferenceOrder string
    PrstHdrVal string
    Ratio string
    ResolveServerByDns string
    RewriteHostHeader string
    ServerNode string
    SrvRdatas List<PoolServerSrvRdata>
    Static string
    VerifyNetwork string
    VmRef string
    Ips []PoolServerIp
    AutoscalingGroupName string
    AvailabilityZone string
    Description string
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    DiscoveredNetworks []PoolServerDiscoveredNetwork
    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ExternalOrchestrationId string
    ExternalUuid string
    HealthMonitorRefs []string
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Hostname string
    Locations []PoolServerLocation
    MacAddress string
    NwRef string
    Port string
    PreferenceOrder string
    PrstHdrVal string
    Ratio string
    ResolveServerByDns string
    RewriteHostHeader string
    ServerNode string
    SrvRdatas []PoolServerSrvRdata
    Static string
    VerifyNetwork string
    VmRef string
    ips List<PoolServerIp>
    autoscalingGroupName String
    availabilityZone String
    description String
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    discoveredNetworks List<PoolServerDiscoveredNetwork>
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    externalOrchestrationId String
    externalUuid String
    healthMonitorRefs List<String>
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hostname String
    locations List<PoolServerLocation>
    macAddress String
    nwRef String
    port String
    preferenceOrder String
    prstHdrVal String
    ratio String
    resolveServerByDns String
    rewriteHostHeader String
    serverNode String
    srvRdatas List<PoolServerSrvRdata>
    static_ String
    verifyNetwork String
    vmRef String
    ips PoolServerIp[]
    autoscalingGroupName string
    availabilityZone string
    description string
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    discoveredNetworks PoolServerDiscoveredNetwork[]
    enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    externalOrchestrationId string
    externalUuid string
    healthMonitorRefs string[]
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hostname string
    locations PoolServerLocation[]
    macAddress string
    nwRef string
    port string
    preferenceOrder string
    prstHdrVal string
    ratio string
    resolveServerByDns string
    rewriteHostHeader string
    serverNode string
    srvRdatas PoolServerSrvRdata[]
    static string
    verifyNetwork string
    vmRef string
    ips Sequence[PoolServerIp]
    autoscaling_group_name str
    availability_zone str
    description str
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    discovered_networks Sequence[PoolServerDiscoveredNetwork]
    enabled str
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    external_orchestration_id str
    external_uuid str
    health_monitor_refs Sequence[str]
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hostname str
    locations Sequence[PoolServerLocation]
    mac_address str
    nw_ref str
    port str
    preference_order str
    prst_hdr_val str
    ratio str
    resolve_server_by_dns str
    rewrite_host_header str
    server_node str
    srv_rdatas Sequence[PoolServerSrvRdata]
    static str
    verify_network str
    vm_ref str
    ips List<Property Map>
    autoscalingGroupName String
    availabilityZone String
    description String
    A description of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    discoveredNetworks List<Property Map>
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    externalOrchestrationId String
    externalUuid String
    healthMonitorRefs List<String>
    Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each service engine and mark a server up or down based on the response. The passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type healthmonitor. Maximum of 50 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    hostname String
    locations List<Property Map>
    macAddress String
    nwRef String
    port String
    preferenceOrder String
    prstHdrVal String
    ratio String
    resolveServerByDns String
    rewriteHostHeader String
    serverNode String
    srvRdatas List<Property Map>
    static String
    verifyNetwork String
    vmRef String

    PoolServerDiscoveredNetwork, PoolServerDiscoveredNetworkArgs

    PoolServerDiscoveredNetworkSubnet, PoolServerDiscoveredNetworkSubnetArgs

    PoolServerDiscoveredNetworkSubnet6, PoolServerDiscoveredNetworkSubnet6Args

    PoolServerDiscoveredNetworkSubnet6IpAddr, PoolServerDiscoveredNetworkSubnet6IpAddrArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    PoolServerDiscoveredNetworkSubnetIpAddr, PoolServerDiscoveredNetworkSubnetIpAddrArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    PoolServerIp, PoolServerIpArgs

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    PoolServerLocation, PoolServerLocationArgs

    Latitude string
    Longitude string
    Name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Tag string
    Latitude string
    Longitude string
    Name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Tag string
    latitude String
    longitude String
    name String
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tag String
    latitude string
    longitude string
    name string
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tag string
    latitude str
    longitude str
    name str
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tag str
    latitude String
    longitude String
    name String
    The name of the pool. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tag String

    PoolServerReselect, PoolServerReselectArgs

    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NumRetries string
    RetryNonidempotent string
    RetryTimeout string
    SvrRespCodes List<PoolServerReselectSvrRespCode>
    Enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    NumRetries string
    RetryNonidempotent string
    RetryTimeout string
    SvrRespCodes []PoolServerReselectSvrRespCode
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    numRetries String
    retryNonidempotent String
    retryTimeout String
    svrRespCodes List<PoolServerReselectSvrRespCode>
    enabled string
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    numRetries string
    retryNonidempotent string
    retryTimeout string
    svrRespCodes PoolServerReselectSvrRespCode[]
    enabled str
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    num_retries str
    retry_nonidempotent str
    retry_timeout str
    svr_resp_codes Sequence[PoolServerReselectSvrRespCode]
    enabled String
    Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    numRetries String
    retryNonidempotent String
    retryTimeout String
    svrRespCodes List<Property Map>

    PoolServerReselectSvrRespCode, PoolServerReselectSvrRespCodeArgs

    PoolServerReselectSvrRespCodeRange, PoolServerReselectSvrRespCodeRangeArgs

    Begin string
    End string
    Begin string
    End string
    begin String
    end String
    begin string
    end string
    begin str
    end str
    begin String
    end String

    PoolServerSrvRdata, PoolServerSrvRdataArgs

    Port string
    Priority string
    Weight string
    Port string
    Priority string
    Weight string
    port String
    priority String
    weight String
    port string
    priority string
    weight string
    port str
    priority str
    weight str
    port String
    priority String
    weight String

    PoolSpGsInfo, PoolSpGsInfoArgs

    Fqdns List<string>
    GsRef string
    Fqdns []string
    GsRef string
    fqdns List<String>
    gsRef String
    fqdns string[]
    gsRef string
    fqdns Sequence[str]
    gs_ref str
    fqdns List<String>
    gsRef String

    Package Details

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