avi 31.1.1, Apr 14 25

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.getPool

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

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

–>

layout: “avi”

page_title: “AVI: avi.Pool” sidebar_current: “docs-avi-datasource-pool” description: |- Get information of Avi Pool.

avi.Pool

This data source is used to to get avi.Pool objects.

Example Usage

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

const fooPool = avi.getPool({
    cloudRef: "/api/cloud/?tenant=admin&name=Default-Cloud",
    name: "foo",
    uuid: "pool-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});

import pulumi
import pulumi_avi as avi

foo_pool = avi.get_pool(cloud_ref="/api/cloud/?tenant=admin&name=Default-Cloud",
    name="foo",
    uuid="pool-f9cf6b3e-a411-436f-95e2-2982ba2b217b")

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.LookupPool(ctx, &avi.LookupPoolArgs{
			CloudRef: pulumi.StringRef("/api/cloud/?tenant=admin&name=Default-Cloud"),
			Name:     pulumi.StringRef("foo"),
			Uuid:     pulumi.StringRef("pool-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		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 fooPool = Avi.GetPool.Invoke(new()
    {
        CloudRef = "/api/cloud/?tenant=admin&name=Default-Cloud",
        Name = "foo",
        Uuid = "pool-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetPoolArgs;
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) {
        final var fooPool = AviFunctions.getPool(GetPoolArgs.builder()
            .cloudRef("/api/cloud/?tenant=admin&name=Default-Cloud")
            .name("foo")
            .uuid("pool-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooPool:
    fn::invoke:
      function: avi:getPool
      arguments:
        cloudRef: /api/cloud/?tenant=admin&name=Default-Cloud
        name: foo
        uuid: pool-f9cf6b3e-a411-436f-95e2-2982ba2b217b

Using getPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>

def get_pool(cloud_ref: Optional[str] = None,
             id: Optional[str] = None,
             ignore_servers: Optional[bool] = None,
             name: Optional[str] = None,
             tenant_ref: Optional[str] = None,
             uuid: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(cloud_ref: Optional[pulumi.Input[str]] = None,
             id: Optional[pulumi.Input[str]] = None,
             ignore_servers: Optional[pulumi.Input[bool]] = None,
             name: Optional[pulumi.Input[str]] = None,
             tenant_ref: Optional[pulumi.Input[str]] = None,
             uuid: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]

func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)
func LookupPoolOutput(ctx *Context, args *LookupPoolOutputArgs, opts ...InvokeOption) LookupPoolResultOutput

> Note: This function is named LookupPool in the Go SDK.

public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
public static Output<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)

fn::invoke:
  function: avi:index/getPool:getPool
  arguments:
    # arguments dictionary

The following arguments are supported:

CloudRef string: Search Pool by cloud_ref.
Id string
IgnoreServers bool
Name string: Search Pool by name.
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.
Uuid string: Search Pool by uuid.

CloudRef string: Search Pool by cloud_ref.
Id string
IgnoreServers bool
Name string: Search Pool by name.
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.
Uuid string: Search Pool by uuid.

cloudRef String: Search Pool by cloud_ref.
id String
ignoreServers Boolean
name String: Search Pool by name.
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.
uuid String: Search Pool by uuid.

cloudRef string: Search Pool by cloud_ref.
id string
ignoreServers boolean
name string: Search Pool by name.
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.
uuid string: Search Pool by uuid.

cloud_ref str: Search Pool by cloud_ref.
id str
ignore_servers bool
name str: Search Pool by name.
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.
uuid str: Search Pool by uuid.

cloudRef String: Search Pool by cloud_ref.
id String
ignoreServers Boolean
name String: Search Pool by name.
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.
uuid String: Search Pool by uuid.

getPool Result

The following output properties are available:

AnalyticsPolicies List<GetPoolAnalyticsPolicy>: 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<GetPoolConfigpbAttribute>: 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<GetPoolConnPoolProperty>: 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<GetPoolFailAction>: 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<GetPoolHorizonProfile>: 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<GetPoolHttp2Property>: Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
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.
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<GetPoolMarker>: 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<GetPoolMaxConnRatePerServer>: 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<GetPoolNetwork>: (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<GetPoolPlacementNetwork>: 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.
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<GetPoolServerReselect>: 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<GetPoolServer>: 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<GetPoolSpGsInfo>: 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.
IgnoreServers bool

AnalyticsPolicies []GetPoolAnalyticsPolicy: 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 []GetPoolConfigpbAttribute: 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 []GetPoolConnPoolProperty: 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 []GetPoolFailAction: 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 []GetPoolHorizonProfile: 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 []GetPoolHttp2Property: Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
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.
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 []GetPoolMarker: 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 []GetPoolMaxConnRatePerServer: 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 []GetPoolNetwork: (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 []GetPoolPlacementNetwork: 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.
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 []GetPoolServerReselect: 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 []GetPoolServer: 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 []GetPoolSpGsInfo: 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.
IgnoreServers bool

analyticsPolicies List<GetPoolAnalyticsPolicy>: 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<GetPoolConfigpbAttribute>: 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<GetPoolConnPoolProperty>: 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<GetPoolFailAction>: 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<GetPoolHorizonProfile>: 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<GetPoolHttp2Property>: Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
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.
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<GetPoolMarker>: 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<GetPoolMaxConnRatePerServer>: 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<GetPoolNetwork>: (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<GetPoolPlacementNetwork>: 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.
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<GetPoolServerReselect>: 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<GetPoolServer>: 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<GetPoolSpGsInfo>: 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.
ignoreServers Boolean

analyticsPolicies GetPoolAnalyticsPolicy[]: 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 GetPoolConfigpbAttribute[]: 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 GetPoolConnPoolProperty[]: 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 GetPoolFailAction[]: 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 GetPoolHorizonProfile[]: 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 GetPoolHttp2Property[]: Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
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.
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 GetPoolMarker[]: 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 GetPoolMaxConnRatePerServer[]: 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 GetPoolNetwork[]: (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 GetPoolPlacementNetwork[]: 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.
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 GetPoolServerReselect[]: 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 GetPoolServer[]: 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 GetPoolSpGsInfo[]: 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.
ignoreServers boolean

analytics_policies Sequence[GetPoolAnalyticsPolicy]: 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[GetPoolConfigpbAttribute]: 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[GetPoolConnPoolProperty]: 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[GetPoolFailAction]: 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[GetPoolHorizonProfile]: 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[GetPoolHttp2Property]: Http2 pool properties. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id str
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.
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[GetPoolMarker]: 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[GetPoolMaxConnRatePerServer]: 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[GetPoolNetwork]: (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[GetPoolPlacementNetwork]: 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_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[GetPoolServerReselect]: 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[GetPoolServer]: 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[GetPoolSpGsInfo]: 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.
ignore_servers bool

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.
id String
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.
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.
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.
ignoreServers Boolean

Supporting Types

GetPoolAnalyticsPolicy

MetricsRealtimeUpdates List<GetPoolAnalyticsPolicyMetricsRealtimeUpdate>

MetricsRealtimeUpdates []GetPoolAnalyticsPolicyMetricsRealtimeUpdate

metricsRealtimeUpdates List<GetPoolAnalyticsPolicyMetricsRealtimeUpdate>

metricsRealtimeUpdates GetPoolAnalyticsPolicyMetricsRealtimeUpdate[]

metrics_realtime_updates Sequence[GetPoolAnalyticsPolicyMetricsRealtimeUpdate]

metricsRealtimeUpdates List<Property Map>

GetPoolAnalyticsPolicyMetricsRealtimeUpdate

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 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 str
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 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.

GetPoolFailActionRedirect

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 str
path str
protocol str
query str
status_code str

host String
path String
protocol String
query String
statusCode String

GetPoolHorizonProfile

BlastPort string
PcoipPort string

BlastPort string
PcoipPort string

blastPort String
pcoipPort String

blastPort string
pcoipPort string

blast_port str
pcoip_port str

blastPort String
pcoipPort String

GetPoolHttp2Property

MaxHttp2ControlFramesPerConnection string
MaxHttp2HeaderFieldSize string

MaxHttp2ControlFramesPerConnection string
MaxHttp2HeaderFieldSize string

maxHttp2ControlFramesPerConnection String
maxHttp2HeaderFieldSize String

maxHttp2ControlFramesPerConnection string
maxHttp2HeaderFieldSize string

max_http2_control_frames_per_connection str
max_http2_header_field_size str

maxHttp2ControlFramesPerConnection String
maxHttp2HeaderFieldSize String

GetPoolMarker

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>

GetPoolMaxConnRatePerServer

Actions List<GetPoolMaxConnRatePerServerAction>
ExplicitTracking string
FineGrain string
HttpCookie string
HttpHeader string
RateLimiters List<GetPoolMaxConnRatePerServerRateLimiter>

Actions []GetPoolMaxConnRatePerServerAction
ExplicitTracking string
FineGrain string
HttpCookie string
HttpHeader string
RateLimiters []GetPoolMaxConnRatePerServerRateLimiter

actions List<GetPoolMaxConnRatePerServerAction>
explicitTracking String
fineGrain String
httpCookie String
httpHeader String
rateLimiters List<GetPoolMaxConnRatePerServerRateLimiter>

actions GetPoolMaxConnRatePerServerAction[]
explicitTracking string
fineGrain string
httpCookie string
httpHeader string
rateLimiters GetPoolMaxConnRatePerServerRateLimiter[]

actions Sequence[GetPoolMaxConnRatePerServerAction]
explicit_tracking str
fine_grain str
http_cookie str
http_header str
rate_limiters Sequence[GetPoolMaxConnRatePerServerRateLimiter]

actions List<Property Map>
explicitTracking String
fineGrain String
httpCookie String
httpHeader String
rateLimiters List<Property Map>

GetPoolMaxConnRatePerServerAction

Files List<GetPoolMaxConnRatePerServerActionFile>
Redirects List<GetPoolMaxConnRatePerServerActionRedirect>
StatusCode string
Type string

Files []GetPoolMaxConnRatePerServerActionFile
Redirects []GetPoolMaxConnRatePerServerActionRedirect
StatusCode string
Type string

files List<GetPoolMaxConnRatePerServerActionFile>
redirects List<GetPoolMaxConnRatePerServerActionRedirect>
statusCode String
type String

files GetPoolMaxConnRatePerServerActionFile[]
redirects GetPoolMaxConnRatePerServerActionRedirect[]
statusCode string
type string

files Sequence[GetPoolMaxConnRatePerServerActionFile]
redirects Sequence[GetPoolMaxConnRatePerServerActionRedirect]
status_code str
type str

files List<Property Map>
redirects List<Property Map>
statusCode String
type String

GetPoolMaxConnRatePerServerActionFile

ContentType string
FileContent string
FileLength string

ContentType string
FileContent string
FileLength string

contentType String
fileContent String
fileLength String

contentType string
fileContent string
fileLength string

content_type str
file_content str
file_length str

contentType String
fileContent String
fileLength String

GetPoolMaxConnRatePerServerActionRedirect

AddString string
Hosts List<GetPoolMaxConnRatePerServerActionRedirectHost>
KeepQuery string
Paths List<GetPoolMaxConnRatePerServerActionRedirectPath>
Port string
Protocol string
StatusCode string

AddString string
Hosts []GetPoolMaxConnRatePerServerActionRedirectHost
KeepQuery string
Paths []GetPoolMaxConnRatePerServerActionRedirectPath
Port string
Protocol string
StatusCode string

addString String
hosts List<GetPoolMaxConnRatePerServerActionRedirectHost>
keepQuery String
paths List<GetPoolMaxConnRatePerServerActionRedirectPath>
port String
protocol String
statusCode String

addString string
hosts GetPoolMaxConnRatePerServerActionRedirectHost[]
keepQuery string
paths GetPoolMaxConnRatePerServerActionRedirectPath[]
port string
protocol string
statusCode string

add_string str
hosts Sequence[GetPoolMaxConnRatePerServerActionRedirectHost]
keep_query str
paths Sequence[GetPoolMaxConnRatePerServerActionRedirectPath]
port str
protocol str
status_code str

addString String
hosts List<Property Map>
keepQuery String
paths List<Property Map>
port String
protocol String
statusCode String

GetPoolMaxConnRatePerServerActionRedirectHost

Tokens List<GetPoolMaxConnRatePerServerActionRedirectHostToken>
Type string

Tokens []GetPoolMaxConnRatePerServerActionRedirectHostToken
Type string

tokens List<GetPoolMaxConnRatePerServerActionRedirectHostToken>
type String

tokens GetPoolMaxConnRatePerServerActionRedirectHostToken[]
type string

tokens Sequence[GetPoolMaxConnRatePerServerActionRedirectHostToken]
type str

tokens List<Property Map>
type String

GetPoolMaxConnRatePerServerActionRedirectHostToken

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

end_index str
start_index str
str_value str
type str

endIndex String
startIndex String
strValue String
type String

GetPoolMaxConnRatePerServerActionRedirectPath

Tokens List<GetPoolMaxConnRatePerServerActionRedirectPathToken>
Type string

Tokens []GetPoolMaxConnRatePerServerActionRedirectPathToken
Type string

tokens List<GetPoolMaxConnRatePerServerActionRedirectPathToken>
type String

tokens GetPoolMaxConnRatePerServerActionRedirectPathToken[]
type string

tokens Sequence[GetPoolMaxConnRatePerServerActionRedirectPathToken]
type str

tokens List<Property Map>
type String

GetPoolMaxConnRatePerServerActionRedirectPathToken

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

end_index str
start_index str
str_value str
type str

endIndex String
startIndex String
strValue String
type String

GetPoolMaxConnRatePerServerRateLimiter

BurstSz string
Count string
Name string: Search Pool by name.
Period string

BurstSz string
Count string
Name string: Search Pool by name.
Period string

burstSz String
count String
name String: Search Pool by name.
period String

burstSz string
count string
name string: Search Pool by name.
period string

burst_sz str
count str
name str: Search Pool by name.
period str

burstSz String
count String
name String: Search Pool by name.
period String

GetPoolNetwork

NetworkRef string
ServerFilter string

NetworkRef string
ServerFilter string

networkRef String
serverFilter String

networkRef string
serverFilter string

network_ref str
server_filter str

networkRef String
serverFilter String

GetPoolPlacementNetwork

NetworkRef string
Subnets List<GetPoolPlacementNetworkSubnet>

NetworkRef string
Subnets []GetPoolPlacementNetworkSubnet

networkRef String
subnets List<GetPoolPlacementNetworkSubnet>

networkRef string
subnets GetPoolPlacementNetworkSubnet[]

network_ref str
subnets Sequence[GetPoolPlacementNetworkSubnet]

networkRef String
subnets List<Property Map>

GetPoolPlacementNetworkSubnet

IpAddrs List<GetPoolPlacementNetworkSubnetIpAddr>
Mask string

IpAddrs []GetPoolPlacementNetworkSubnetIpAddr
Mask string

ipAddrs List<GetPoolPlacementNetworkSubnetIpAddr>
mask String

ipAddrs GetPoolPlacementNetworkSubnetIpAddr[]
mask string

ip_addrs Sequence[GetPoolPlacementNetworkSubnetIpAddr]
mask str

ipAddrs List<Property Map>
mask String

GetPoolPlacementNetworkSubnetIpAddr

Addr string
Type string

Addr string
Type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetPoolServer

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<GetPoolServerDiscoveredNetwork>
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
Ips List<GetPoolServerIp>
Locations List<GetPoolServerLocation>
MacAddress string
NwRef string
Port string
PreferenceOrder string
PrstHdrVal string
Ratio string
ResolveServerByDns string
RewriteHostHeader string
ServerNode string
SrvRdatas List<GetPoolServerSrvRdata>
Static string
VerifyNetwork string
VmRef string

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 []GetPoolServerDiscoveredNetwork
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
Ips []GetPoolServerIp
Locations []GetPoolServerLocation
MacAddress string
NwRef string
Port string
PreferenceOrder string
PrstHdrVal string
Ratio string
ResolveServerByDns string
RewriteHostHeader string
ServerNode string
SrvRdatas []GetPoolServerSrvRdata
Static string
VerifyNetwork string
VmRef string

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<GetPoolServerDiscoveredNetwork>
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
ips List<GetPoolServerIp>
locations List<GetPoolServerLocation>
macAddress String
nwRef String
port String
preferenceOrder String
prstHdrVal String
ratio String
resolveServerByDns String
rewriteHostHeader String
serverNode String
srvRdatas List<GetPoolServerSrvRdata>
static_ String
verifyNetwork String
vmRef String

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 GetPoolServerDiscoveredNetwork[]
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
ips GetPoolServerIp[]
locations GetPoolServerLocation[]
macAddress string
nwRef string
port string
preferenceOrder string
prstHdrVal string
ratio string
resolveServerByDns string
rewriteHostHeader string
serverNode string
srvRdatas GetPoolServerSrvRdata[]
static string
verifyNetwork string
vmRef string

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[GetPoolServerDiscoveredNetwork]
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
ips Sequence[GetPoolServerIp]
locations Sequence[GetPoolServerLocation]
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[GetPoolServerSrvRdata]
static str
verify_network str
vm_ref str

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
ips List<Property Map>
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

GetPoolServerDiscoveredNetwork

NetworkRef string
Subnet6s List<GetPoolServerDiscoveredNetworkSubnet6>
Subnets List<GetPoolServerDiscoveredNetworkSubnet>

NetworkRef string
Subnet6s []GetPoolServerDiscoveredNetworkSubnet6
Subnets []GetPoolServerDiscoveredNetworkSubnet

networkRef String
subnet6s List<GetPoolServerDiscoveredNetworkSubnet6>
subnets List<GetPoolServerDiscoveredNetworkSubnet>

networkRef string
subnet6s GetPoolServerDiscoveredNetworkSubnet6[]
subnets GetPoolServerDiscoveredNetworkSubnet[]

network_ref str
subnet6s Sequence[GetPoolServerDiscoveredNetworkSubnet6]
subnets Sequence[GetPoolServerDiscoveredNetworkSubnet]

networkRef String
subnet6s List<Property Map>
subnets List<Property Map>

GetPoolServerDiscoveredNetworkSubnet

IpAddrs List<GetPoolServerDiscoveredNetworkSubnetIpAddr>
Mask string

IpAddrs []GetPoolServerDiscoveredNetworkSubnetIpAddr
Mask string

ipAddrs List<GetPoolServerDiscoveredNetworkSubnetIpAddr>
mask String

ipAddrs GetPoolServerDiscoveredNetworkSubnetIpAddr[]
mask string

ip_addrs Sequence[GetPoolServerDiscoveredNetworkSubnetIpAddr]
mask str

ipAddrs List<Property Map>
mask String

GetPoolServerDiscoveredNetworkSubnet6

IpAddrs List<GetPoolServerDiscoveredNetworkSubnet6IpAddr>
Mask string

IpAddrs []GetPoolServerDiscoveredNetworkSubnet6IpAddr
Mask string

ipAddrs List<GetPoolServerDiscoveredNetworkSubnet6IpAddr>
mask String

ipAddrs GetPoolServerDiscoveredNetworkSubnet6IpAddr[]
mask string

ip_addrs Sequence[GetPoolServerDiscoveredNetworkSubnet6IpAddr]
mask str

ipAddrs List<Property Map>
mask String

GetPoolServerDiscoveredNetworkSubnet6IpAddr

Addr string
Type string

Addr string
Type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetPoolServerDiscoveredNetworkSubnetIpAddr

Addr string
Type string

Addr string
Type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetPoolServerIp

Addr string
Type string

Addr string
Type string

addr String
type String

addr string
type string

addr str
type str

addr String
type String

GetPoolServerLocation

Latitude string
Longitude string
Name string: Search Pool by name.
Tag string

Latitude string
Longitude string
Name string: Search Pool by name.
Tag string

latitude String
longitude String
name String: Search Pool by name.
tag String

latitude string
longitude string
name string: Search Pool by name.
tag string

latitude str
longitude str
name str: Search Pool by name.
tag str

latitude String
longitude String
name String: Search Pool by name.
tag String

GetPoolServerReselect

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<GetPoolServerReselectSvrRespCode>

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 []GetPoolServerReselectSvrRespCode

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<GetPoolServerReselectSvrRespCode>

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 GetPoolServerReselectSvrRespCode[]

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[GetPoolServerReselectSvrRespCode]

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>

GetPoolServerReselectSvrRespCode

Codes List<double>
Ranges List<GetPoolServerReselectSvrRespCodeRange>
RespCodeBlocks List<string>

Codes []float64
Ranges []GetPoolServerReselectSvrRespCodeRange
RespCodeBlocks []string

codes List<Double>
ranges List<GetPoolServerReselectSvrRespCodeRange>
respCodeBlocks List<String>

codes number[]
ranges GetPoolServerReselectSvrRespCodeRange[]
respCodeBlocks string[]

codes Sequence[float]
ranges Sequence[GetPoolServerReselectSvrRespCodeRange]
resp_code_blocks Sequence[str]

codes List<Number>
ranges List<Property Map>
respCodeBlocks List<String>

GetPoolServerReselectSvrRespCodeRange

Begin string
End string

Begin string
End string

begin String
end String

begin string
end string

begin str
end str

begin String
end String

GetPoolServerSrvRdata

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

GetPoolSpGsInfo

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 31.1.1 published on Monday, Apr 14, 2025 by vmware

vmware/terraform-provider-avi

avi.getPool

On this page

On this page

<!–

–>

layout: “avi”

page_title: “AVI: avi.Pool” sidebar_current: “docs-avi-datasource-pool” description: |- Get information of Avi Pool.

avi.Pool

Example Usage

Using getPool

getPool Result

Supporting Types

GetPoolAnalyticsPolicy

GetPoolAnalyticsPolicyMetricsRealtimeUpdate

GetPoolConfigpbAttribute

GetPoolConnPoolProperty

GetPoolFailAction

GetPoolFailActionLocalRsp

GetPoolFailActionLocalRspFile

GetPoolFailActionRedirect

GetPoolHorizonProfile

GetPoolHttp2Property

GetPoolMarker

GetPoolMaxConnRatePerServer

GetPoolMaxConnRatePerServerAction

GetPoolMaxConnRatePerServerActionFile

GetPoolMaxConnRatePerServerActionRedirect

GetPoolMaxConnRatePerServerActionRedirectHost

GetPoolMaxConnRatePerServerActionRedirectHostToken

GetPoolMaxConnRatePerServerActionRedirectPath

GetPoolMaxConnRatePerServerActionRedirectPathToken

GetPoolMaxConnRatePerServerRateLimiter

GetPoolNetwork

GetPoolPlacementNetwork

GetPoolPlacementNetworkSubnet

GetPoolPlacementNetworkSubnetIpAddr

GetPoolServer

GetPoolServerDiscoveredNetwork

GetPoolServerDiscoveredNetworkSubnet

GetPoolServerDiscoveredNetworkSubnet6

GetPoolServerDiscoveredNetworkSubnet6IpAddr

GetPoolServerDiscoveredNetworkSubnetIpAddr

GetPoolServerIp

GetPoolServerLocation

GetPoolServerReselect

GetPoolServerReselectSvrRespCode

GetPoolServerReselectSvrRespCodeRange

GetPoolServerSrvRdata

GetPoolSpGsInfo

Package Details

On this page

On this page