[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

InlineLBPool1

Properties

array of string
active_monitor_paths Optional

In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the pool. Currently, only one active health monitor can be configured per server pool.


string
algorithm Optional

Load Balancing algorithm chooses a server for each new connection by going through the list of servers in the pool. Currently, following load balancing algorithms are supported with ROUND_ROBIN as the default. ROUND_ROBIN means that a server is selected in a round-robin fashion. The weight would be ignored even if it is configured. WEIGHTED_ROUND_ROBIN means that a server is selected in a weighted round-robin fashion. Default weight of 1 is used if weight is not configured. LEAST_CONNECTION means that a server is selected when it has the least number of connections. The weight would be ignored even if it is configured. Slow start would be enabled by default. WEIGHTED_LEAST_CONNECTION means that a server is selected in a weighted least connection fashion. Default weight of 1 is used if weight is not configured. Slow start would be enabled by default. IP_HASH means that consistent hash is performed on the source IP address of the incoming connection. This ensures that the same client IP address will always reach the same server as long as no server goes down or up. It may be used on the Internet to provide a best-effort stickiness to clients which refuse session cookies.

Possible values are: ROUND_ROBINWEIGHTED_ROUND_ROBINLEAST_CONNECTIONWEIGHTED_LEAST_CONNECTIONIP_HASH


member_group Optional

Load balancer pool support grouping object as dynamic pool members. When member group is defined, members setting should not be specified.


array of LBPoolMember
members Optional

Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port.


integer as int64
min_active_members Optional

A pool is considered active if there are at least certain minimum number of members.


string
passive_monitor_path Optional

Passive healthchecks are disabled by default and can be enabled by attaching a passive health monitor to a server pool. Each time a client connection to a pool member fails, its failed count is incremented. For pools bound to L7 virtual servers, a connection is considered to be failed and failed count is incremented if any TCP connection errors (e.g. TCP RST or failure to send data) or SSL handshake failures occur. For pools bound to L4 virtual servers, if no response is received to a TCP SYN sent to the pool member or if a TCP RST is received in response to a TCP SYN, then the pool member is considered to have failed and the failed count is incremented.


snat_translation Optional

Depending on the topology, Source NAT (SNAT) may be required to ensure traffic from the server destined to the client is received by the load balancer. SNAT can be enabled per pool. If SNAT is not enabled for a pool, then load balancer uses the client IP and port (spoofing) while establishing connections to the servers. This is referred to as no-SNAT or TRANSPARENT mode. By default Source NAT is enabled as LBSnatAutoMap.


boolean
tcp_multiplexing_enabled Optional

TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections.


integer as int64
tcp_multiplexing_number Optional

The maximum number of TCP connections per pool that are idly kept alive for sending future client requests.

JSON Example

{
	"active_monitor_paths": [
		"string"
	],
	"algorithm": "ROUND_ROBIN",
	"member_group": {
		"customized_members": [
			{
				"admin_state": "ENABLED",
				"display_name": "string",
				"ip_address": "string",
				"port": "string",
				"weight": 0
			}
		],
		"group_path": "string",
		"ip_revision_filter": "IPV4",
		"max_ip_list_size": 0,
		"port": 0
	},
	"members": [
		{
			"admin_state": "ENABLED",
			"backup_member": false,
			"display_name": "string",
			"ip_address": "string",
			"max_concurrent_connections": 0,
			"port": "string",
			"weight": 0
		}
	],
	"min_active_members": 0,
	"passive_monitor_path": "string",
	"snat_translation": {
		"type": "LBSnatAutoMap"
	},
	"tcp_multiplexing_enabled": false,
	"tcp_multiplexing_number": 0
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vmw-nsx-module: PolicyLoadBalancer
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Used By

LBPool

Feedback

Was this page helpful?