Create or update a ALBpool

If a ALBpool with the alb-pool-id is not already present,
create a new ALBpool. If it already exists, update the
ALBpool. This is a full replace.
This API is only available when using VMware NSX-T.

Request:

Method:

PATCH

URI Path(s):

/policy/api/v1/infra/alb-pools/<alb-pool-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ALBPool+

ALBPool (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
analytics_policy	Analytics policy Determines analytics settings for the pool.	ALBPoolAnalyticsPolicy
analytics_profile_path	Analytics profile path Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile.	string
apic_epg_name	Apic epg name Synchronize Cisco APIC EPG members with pool servers.	string
application_persistence_profile_path	Application persistence profile path 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.	string
autoscale_launch_config_path	Autoscale launch config path If configured then Avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type AutoScaleLaunchConfig.	string
autoscale_networks	Autoscale networks Network Ids for the launch configuration.	array of string
autoscale_policy_path	Autoscale policy path Reference to Server Autoscale Policy. It is a reference to an object of type ServerAutoScalePolicy.	string
capacity_estimation	Capacity estimation Inline estimation of capacity of servers. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"
capacity_estimation_ttfb_thresh	Capacity estimation ttfb thresh The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - 'Automatic'. Unit is MILLISECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 0.	integer	Minimum: 0 Maximum: 5000 Default: "0"
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
cloud_config_cksum	Cloud config cksum Checksum of cloud configuration for Pool. Internally set by cloud connector.	string
conn_pool_properties	Conn pool properties Connnection pool properties.	ALBConnPoolProperties
connection_ramp_duration	Connection ramp duration 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. Default value when not specified in API or module is interpreted by ALB Controller as 10.	integer	Minimum: 0 Maximum: 300 Default: "10"
created_by	Created by Creator name.	string
default_server_port	Default server port 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. Default value when not specified in API or module is interpreted by ALB Controller as 80.	integer	Minimum: 1 Maximum: 65535 Default: "80"
delete_server_on_dns_refresh	Delete server on dns refresh 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. Default value when not specified in API or module is interpreted by ALB Controller as true.	boolean	Default: "True"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
domain_name	Domain name 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.	array of string
east_west	East west Inherited config from VirtualService.	boolean
enable_http2	Enable http2 Enable HTTP/2 for traffic from VirtualService to all backend servers in this pool. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"
enabled	Enabled Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Default value when not specified in API or module is interpreted by ALB Controller as true.	boolean	Default: "True"
external_autoscale_groups	External autoscale groups Names of external auto-scale groups for pool servers. Currently available only for AWS and Azure.	array of string
fail_action	Fail action 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.	ALBFailAction
fewest_tasks_feedback_delay	Fewest tasks feedback delay Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 10.	integer	Minimum: 1 Maximum: 300 Default: "10"
graceful_disable_timeout	Graceful disable timeout 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. Default value when not specified in API or module is interpreted by ALB Controller as 1.	integer	Minimum: -1 Maximum: 7200 Default: "1"
group_paths	Group paths A list of NSX Groups where the Servers for the Pool are created .	array of string
gslb_sp_enabled	Gslb sp enabled Indicates if the pool is a site-persistence pool.	boolean
health_monitor_paths	Health monitor paths 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.	array of string
host_check_enabled	Host check enabled 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. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
ignore_server_port	Ignore server port 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. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"
inline_health_monitor	Inline health monitor 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. Default value when not specified in API or module is interpreted by ALB Controller as true.	boolean	Default: "True"
ipaddrgroup_path	Ipaddrgroup path Use list of servers from Ip Address Group. It is a reference to an object of type IpAddrGroup.	string
lb_algorithm	Lb algorithm 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. Default value when not specified in API or module is interpreted by ALB Controller as LB_ALGORITHM_LEAST_CONNECTIONS.	ALBLbAlgorithm	Default: "LB_ALGORITHM_LEAST_CONNECTIONS"
lb_algorithm_consistent_hash_hdr	Lb algorithm consistent hash hdr HTTP header name to be used for the hash key.	string
lb_algorithm_core_nonaffinity	Lb algorithm core nonaffinity Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Default value when not specified in API or module is interpreted by ALB Controller as 2.	integer	Minimum: 1 Maximum: 65535 Default: "2"
lb_algorithm_hash	Lb algorithm hash 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. Default value when not specified in API or module is interpreted by ALB Controller as LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS.	ALBLbAlgorithmConsistentHash	Default: "LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS"
lookup_server_by_name	Lookup server by name Allow server lookup by name. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
max_concurrent_connections_per_server	Max concurrent connections per server 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. Default value when not specified in API or module is interpreted by ALB Controller as 0.	integer	Default: "0"
max_conn_rate_per_server	Max conn rate per server Rate Limit connections to each server.	ALBRateProfile
min_health_monitors_up	Min health monitors up Minimum number of health monitors in UP state to mark server UP.	integer
min_servers_up	Min servers up Minimum number of servers in UP state for marking the pool UP.	integer
networks	Networks (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.	array of ALBNetworkFilter
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
pki_profile_path	Pki profile path 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.	string
placement_networks	Placement networks 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.	array of ALBPlacementNetwork
relative_path	Relative path of this object Path relative from its parent	string	Readonly
request_queue_depth	Request queue depth Minimum number of requests to be queued when pool is full. Default value when not specified in API or module is interpreted by ALB Controller as 128.	integer	Default: "128"
request_queue_enabled	Request queue enabled Enable request queue when pool is full. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"
resource_type	Must be set to the value ALBPool	string
rewrite_host_header_to_server_name	Rewrite host header to server name 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. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"
rewrite_host_header_to_sni	Rewrite host header to sni If SNI server name is specified, rewrite incoming host header to the SNI server name. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"
routing_pool	Routing pool Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"
server_name	Server name 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.	string
server_reselect	Server reselect Server reselect configuration for HTTP requests.	ALBHTTPServerReselect
server_timeout	Server timeout 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-3600000. Unit is MILLISECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 0.	integer	Minimum: 0 Maximum: 3600000 Default: "0"
servers	Servers 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.	array of ALBServer
service_metadata	Service metadata 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.	string
sni_enabled	Sni enabled Enable TLS SNI for server connections. If disabled, Avi will not send the SNI extension as part of the handshake. Default value when not specified in API or module is interpreted by ALB Controller as true.	boolean	Default: "True"
ssl_key_and_certificate_path	Ssl key and certificate path Service Engines will present a client SSL certificate to the server. It is a reference to an object of type SSLKeyAndCertificate.	string
ssl_profile_path	Ssl profile path 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.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tier1_path	Tier1 path This tier1_lr field should be set same as VirtualService associated for NSX-T.	string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
use_service_port	Use service port Do not translate the client's destination port when sending the connection to the server. The pool or servers specified service port will still be used for health monitoring. Default value when not specified in API or module is interpreted by ALB Controller as false.	boolean	Default: "False"

Example Request:

{ "health_monitor_paths": [ "/infra/alb-health-monitors/httpMonitor" ], "lb_algorithm": "LB_ALGORITHM_LEAST_CONNECTIONS", "name": "testPool1", "servers": [ { "enabled": true, "ip": { "addr": "", "type": "V4" }, "prst_hdr_val": "", "ratio": 1, "resolve_server_by_dns": false, "rewrite_host_header": false, "static": false, "verify_network": false } ] }

Successful Response:

Response Code:

200 OK

Response Headers:

n/a

Response Body:

n/a

Example Response:

200 OK

Required Permissions:

crud

Feature:

policy_lb

Create or update a ALBpool

Request:

ALBPool (schema)

Example Request:

Successful Response:

Example Response:

Required Permissions:

Feature:

Additional Errors: