Properties are collected for the pool object type.

Pool Properties

Property Name Category Description
Name Summary Name of the object.
UUID Summary UUID of the object to fetch.
Status Summary Enable or disable the pool. Disabling will terminate all open connections and pause health monitors.
Active Monitors Summary Verifies 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. Reference to an object of type HealthMonitor.
Server Name Summary DNS resolvable name of the server. May be used in place of the IP address.
IP Address Summary IP address of the server. Required if there is no resolvable host name.
Port Summary Optionally specify the servers port number. This will override the pool's default server port attribute.
Row Summary Ratio of selecting eligible servers in the pool. Allowed values are 1-20.
Cloud Summary Reference to an object of type Cloud.
Tenant Summary Reference to an object of type Tenant.
Virtual Services Count Summary Count of virtual services using this pool.
Virtual Services Summary Name of the virtual services using this pool.
Servers (Up/Total) Summary Ratio of the total number of servers in the pool that are up, to the total number of servers configured in the pool.
VRF Context Summary Virtual Routing Context that the pool is bound to. Used to provide isolation of the set of networks the pool is attached to. Reference to an object of type VrfContext
Active Health Monitors Summary Verifies server health by applying one or more health monitors. Reference to an object of type HealthMonitor.
Server Name Summary DNS resolvable name of the server. May be used in place of the IP address.
Status Summary Enable, disable, or graceful disable determine if new or existing connections to the server are allowed.
IP Address Summary IP Address of the server.
Port Summary Port number of the server. Overrides the pool's default server port attribute.
Ratio Summary Ratio of selecting eligible servers in the pool. Allowed values are 1-20.
Default Server Port Configuration Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute.
Graceful Disable Timeout Configuration Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled.
Load Balance Algorithm Configuration The load balancing algorithm will pick a server within the pool's list of available servers.
Passive Health Monitor Configuration The Passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses.
Min. Health Monitors to consider server 'up' Configuration Minimum number of health monitors in UP state to mark server UP.
AutoScale Policy Configuration Reference to Server Autoscale Policy. Reference to an object of type ServerAutoScalePolicy.
AutoScale Launch Config Configuration If configured, then the NSX Advanced Load Balancer will trigger an orchestration of pool server creation and deletion. Reference to an object of type AutoScaleLaunchConfig.
Persistence Configuration Persistence ensures that a user sticks to the same server for a desired duration of time. Reference to an object of type ApplicationPersistenceProfile.
Analytics Profile Configuration Specifies settings related to analytics. Reference to an object of type AnalyticsProfile.
Append Port Configuration 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.
Lookup Server by Name Configuration Server lookup by name.
Rewrite Host Header to Server Name Configuration Rewrite incoming Host Header to server name of the server to which the request is proxied.
Enable real time metrics Configuration Enable real time metrics for server and pool metrics.
SSL SSL to backend servers When enabled, the NSX Advanced Load Balancer re-encrypts traffic to the backend servers. The specific SSL profile defines which ciphers and SSL versions will be supported. Reference to an object of type SSLProfile.
Server Disable Type SSL to backend servers Server graceful disable timeout behavior.
Request Queuing Pool Full Settings Enable request queue when pool is full.
Queue Length Pool Full Settings Minimum number of requests to be queued when pool is full.
Fail Action Pool Full Settings Enables a response to the client when the pool experiences a failure. By default TCP connection is closed.
Placement Settings/Server Network Pool Full Settings Manually select the networks and subnets used to provide reachability to the pool's servers.
Connection Idle Timeout Connection Pool Settings Connection idle timeout.
Connection Life Timeout Connection Pool Settings Connection life timeout.
Connection Max Used Times Connection Pool Settings Maximum number of times a connection can be reused.
Max Cache Connections Per Server Connection Pool Settings Maximum number of connections a server can cache.
Disable Port Translation Other Settings Does not translate the client's destination port when sending the connection to the server.
Default Server Timeout Other Settings Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between the NSX Advanced Load Balancer and the server.
Connection Ramp Other Settings Duration for which new connections will be gradually ramped up to a server recently brought online.
Max Connections per Server Other Settings The maximum number of concurrent connections allowed to each server within the pool.
Routing Pool Other Settings Routing is enabled when this pool is selected to send traffic.
HTTP Server Reselect Other Settings Server reselect configuration for HTTP requests.