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

InlineLBVirtualServer1

Properties

string as ip
ip_address Required

Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers.


string
application_profile_path Required

The application profile defines the application protocol characteristics. It is used to influence how load balancing is performed. Currently, LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile, etc are supported.


array of string as port-or-range
ports Required

Ports contains a list of at least one port or port range such as “80”, “1234-1236”. Each port element in the list should be a single port or a single port range.


boolean
access_log_enabled Optional

If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled.


boolean
enabled Optional

Flag to enable the load balancer virtual server.


array of string as port-or-range
default_pool_member_ports Optional

Default pool member ports when member port is not defined.


string
lb_persistence_profile_path Optional

Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default.


string
lb_service_path Optional

virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), LB virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities.


integer as int64
max_concurrent_connections Optional

To ensure one virtual server does not over consume resources, affecting other applications hosted on the same LBS, connections to a virtual server can be capped. If it is not specified, it means that connections are unlimited.


integer as int64
max_new_connection_rate Optional

To ensure one virtual server does not over consume resources, connections to a member can be rate limited. If it is not specified, it means that connection rate is unlimited.


string
pool_path Optional

The server pool(LBPool) contains backend servers. Server pool consists of one or more servers, also referred to as pool members, that are similarly configured and are running the same application.


client_ssl_profile_binding Optional

The setting is used when load balancer acts as an SSL server and terminating the client SSL connection


array of LBRule
rules Optional

Load balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with LBHttpProfile.


server_ssl_profile_binding Optional

The setting is used when load balancer acts as an SSL client and establishing a connection to the backend server.


string
sorry_pool_path Optional

When load balancer can not select a backend server to serve the request in default pool or pool in rules, the request would be served by sorry server pool.

JSON Example

{
	"application_profile_path": "string",
	"ip_address": "string",
	"ports": [
		"string"
	]
}

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

LBVirtualServer

Feedback

Was this page helpful?