NSX-T Data Center REST API

Create a load balancer virtual server (Deprecated)

Create a load balancer virtual server.
Deprecated:
Use the following Policy API -
PATCH /policy/api/v1/infra/lb-virtual-servers/

Request:

Method:

POST

URI Path(s):

/api/v1/loadbalancer/virtual-servers

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

LbVirtualServer+

LbVirtualServer (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
access_list_control	IP access list control to filter the connections Specifies the access list control to define how to filter the connections from clients.	LbAccessListControl
access_log_enabled	Whether access log is enabled	boolean	Default: "False"
application_profile_id	application profile identifier 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.	string	Required
client_ssl_profile_binding	Virtual server side SSL binding setting The setting is used when load balancer acts as an SSL server and terminating the client SSL connection The property is deprecated as NSX-T Load Balancer is deprecated.	ClientSslProfileBinding	Deprecated
default_pool_member_port	Default pool member port when member port is not defined. This is a deprecated property, please use 'default_pool_member_ports' instead. If default_pool_member_port is configured and default_pool_member_ports are not specified, both default_pool_member_port and default_pool_member_ports in response payload would return the same port value. If both are specified, default_pool_member_ports setting would take effect with higher priority.	PortElement	Deprecated
default_pool_member_ports	Default pool member ports when member port is not defined. If default_pool_member_ports are configured, both default_pool_member_port and default_pool_member_ports in the response payload would include port settings, notice that the value of default_pool_member_port is the first element of default_pool_member_ports.	array of PortElement	Maximum items: 14
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
enabled	whether the virtual server is enabled	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ip_address	virtual server IP address	IPAddress	Required
ip_protocol	virtual server IP protocol Assigned Internet Protocol in IP header, TCP, UDP are supported.	VirtualServerIpProtocol	Default: "TCP"
log_significant_event_only	Log only significant event in access log The property log_significant_event_only can take effect only when access_log_enabled is true. If log_significant_event_only is true, significant events are logged in access log. For L4 virtual server, significant event means unsuccessful(error or dropped) TCP/UDP connections. For L7 virtual server, significant event means unsuccessful connections or HTTP/HTTPS requests which have error response code(e.g. 4xx, 5xx).	boolean	Default: "False"
max_concurrent_connections	maximum concurrent connection number 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. The property is deprecated as NSX-T Load Balancer is deprecated.	integer	Deprecated Minimum: 1 Maximum: 2147483647
max_new_connection_rate	maximum new connection rate in second 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. The property is deprecated as NSX-T Load Balancer is deprecated.	integer	Deprecated Minimum: 1 Maximum: 2147483647
persistence_profile_id	persistence profile identifier Persistence profile is used to allow related client connections to be sent to the same backend server.	string
pool_id	default server pool identifier 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.	string
port	Virtual server port number or port range This is a deprecated property, please use 'ports' instead. Port setting could be single port for both L7 mode and L4 mode. For L4 mode, a single port range is also supported. The port setting could be a single port or port range such as "80", "1234-1236". If port is configured and ports are not specified, both port and ports in response payload would return the same port value. If both port and ports are configured, ports setting would take effect with higher priority.	PortElement	Deprecated
ports	Virtual server ports or port ranges Port setting could be a single port for both L7 mode and L4 mode. For L4 mode, multiple ports or port ranges are also supported such as "80", "443", "1234-1236". If ports is configured, both port and ports in the response payload would include port settings, notice that the port field value is the first element of ports.	array of PortElement	Maximum items: 14
resource_type	Must be set to the value LbVirtualServer	string
rule_ids	List of load balancer rule identifiers 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. The property is deprecated as NSX-T Load Balancer is deprecated.	array of string	Deprecated Maximum items: 4000
server_ssl_profile_binding	Pool side SSL binding setting The setting is used when load balancer acts as an SSL client and establishing a connection to the backend server. The property is deprecated as NSX-T Load Balancer is deprecated.	ServerSslProfileBinding	Deprecated
sorry_pool_id	Identifier of sorry server pool 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. The property is deprecated as NSX-T Load Balancer is deprecated.	string	Deprecated
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST https://<nsx-mgr>/api/v1/loadbalancer/virtual-servers { "ip_protocol":"TCP", "enabled":"true", "pool_id":"356ab0ad-3fdc-48ef-b9df-8c05cedc0fc3", "default_pool_member_port" : "80", "application_profile_id":"cb2d0721-cc15-5b8e-8633-14be114eac5e", "ip_address":"123.123.123.123", "port":"80", "display_name":"LB_HTTP_VirtualServer", "description":"LB_HTTP_VirtualServer created through automation" }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

LbVirtualServer+

LbVirtualServer (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
access_list_control	IP access list control to filter the connections Specifies the access list control to define how to filter the connections from clients.	LbAccessListControl
access_log_enabled	Whether access log is enabled	boolean	Default: "False"
application_profile_id	application profile identifier 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.	string	Required
client_ssl_profile_binding	Virtual server side SSL binding setting The setting is used when load balancer acts as an SSL server and terminating the client SSL connection The property is deprecated as NSX-T Load Balancer is deprecated.	ClientSslProfileBinding	Deprecated
default_pool_member_port	Default pool member port when member port is not defined. This is a deprecated property, please use 'default_pool_member_ports' instead. If default_pool_member_port is configured and default_pool_member_ports are not specified, both default_pool_member_port and default_pool_member_ports in response payload would return the same port value. If both are specified, default_pool_member_ports setting would take effect with higher priority.	PortElement	Deprecated
default_pool_member_ports	Default pool member ports when member port is not defined. If default_pool_member_ports are configured, both default_pool_member_port and default_pool_member_ports in the response payload would include port settings, notice that the value of default_pool_member_port is the first element of default_pool_member_ports.	array of PortElement	Maximum items: 14
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
enabled	whether the virtual server is enabled	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ip_address	virtual server IP address	IPAddress	Required
ip_protocol	virtual server IP protocol Assigned Internet Protocol in IP header, TCP, UDP are supported.	VirtualServerIpProtocol	Default: "TCP"
log_significant_event_only	Log only significant event in access log The property log_significant_event_only can take effect only when access_log_enabled is true. If log_significant_event_only is true, significant events are logged in access log. For L4 virtual server, significant event means unsuccessful(error or dropped) TCP/UDP connections. For L7 virtual server, significant event means unsuccessful connections or HTTP/HTTPS requests which have error response code(e.g. 4xx, 5xx).	boolean	Default: "False"
max_concurrent_connections	maximum concurrent connection number 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. The property is deprecated as NSX-T Load Balancer is deprecated.	integer	Deprecated Minimum: 1 Maximum: 2147483647
max_new_connection_rate	maximum new connection rate in second 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. The property is deprecated as NSX-T Load Balancer is deprecated.	integer	Deprecated Minimum: 1 Maximum: 2147483647
persistence_profile_id	persistence profile identifier Persistence profile is used to allow related client connections to be sent to the same backend server.	string
pool_id	default server pool identifier 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.	string
port	Virtual server port number or port range This is a deprecated property, please use 'ports' instead. Port setting could be single port for both L7 mode and L4 mode. For L4 mode, a single port range is also supported. The port setting could be a single port or port range such as "80", "1234-1236". If port is configured and ports are not specified, both port and ports in response payload would return the same port value. If both port and ports are configured, ports setting would take effect with higher priority.	PortElement	Deprecated
ports	Virtual server ports or port ranges Port setting could be a single port for both L7 mode and L4 mode. For L4 mode, multiple ports or port ranges are also supported such as "80", "443", "1234-1236". If ports is configured, both port and ports in the response payload would include port settings, notice that the port field value is the first element of ports.	array of PortElement	Maximum items: 14
resource_type	Must be set to the value LbVirtualServer	string
rule_ids	List of load balancer rule identifiers 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. The property is deprecated as NSX-T Load Balancer is deprecated.	array of string	Deprecated Maximum items: 4000
server_ssl_profile_binding	Pool side SSL binding setting The setting is used when load balancer acts as an SSL client and establishing a connection to the backend server. The property is deprecated as NSX-T Load Balancer is deprecated.	ServerSslProfileBinding	Deprecated
sorry_pool_id	Identifier of sorry server pool 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. The property is deprecated as NSX-T Load Balancer is deprecated.	string	Deprecated
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type" : "LbVirtualServer", "description" : "LB_HTTP_VirtualServer", "id" : "801ebbb3-90bf-403b-b061-9ec6294813b2", "display_name" : "LB_HTTP_VirtualServer", "ip_address" : "123.123.123.123", "pool_id" : "356ab0ad-3fdc-48ef-b9df-8c05cedc0fc3", "enabled" : true, "ip_protocol" : "TCP", "default_pool_member_port" : "80", "port" : "80", "application_profile_id" : "5563bc87-799d-4340-9715-27e43cb1e60c", "_create_user" : "admin", "_create_time" : 1506659379394, "_last_modified_user" : "admin", "_last_modified_time" : 1506659379394, "_system_owned" : false, "_protection" : "NOT_PROTECTED", "_revision" : 0 }

Required Permissions:

crud

Feature:

lb_virtual_servers

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable