InlineLbVirtualServer1

InlineLbVirtualServer1
InlineLbVirtualServer1
JSON Example
{
    "access_list_control": {
        "action": "string",
        "enabled": false,
        "group_id": "string"
    },
    "access_log_enabled": false,
    "application_profile_id": "string",
    "client_ssl_profile_binding": "ClientSslProfileBinding Object",
    "default_pool_member_port": "string",
    "default_pool_member_ports": [
        "string"
    ],
    "enabled": false,
    "ip_address": "string",
    "ip_protocol": "string",
    "log_significant_event_only": false,
    "max_concurrent_connections": 0,
    "max_new_connection_rate": 0,
    "persistence_profile_id": "string",
    "pool_id": "string",
    "port": "string",
    "ports": [
        "string"
    ],
    "rule_ids": [
        "string"
    ],
    "server_ssl_profile_binding": "ServerSslProfileBinding Object",
    "sorry_pool_id": "string"
}
access_list_control
Optional

LbAccessListControl is used to define how IP access list control can filter the connections from clients.

boolean
access_log_enabled
Optional

Whether access log is enabled

string
application_profile_id
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.

client_ssl_profile_binding
Optional

client_ssl_profile_binding

string As port-or-range As port-or-range
default_pool_member_port
Optional

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.

array of string
default_pool_member_ports
Optional
Constraints: maxItems: 14

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.

boolean
enabled
Optional
Constraints: default: true

whether the virtual server is enabled

string As ip As ip
ip_address
Required

virtual server IP address

string
ip_protocol
Optional
Constraints: default: TCP

Assigned Internet Protocol in IP header, TCP, UDP are supported.

Possible values are : TCP, UDP,
boolean
log_significant_event_only
Optional

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).

integer As int64 As int64
max_concurrent_connections
Optional
Constraints: minimum: 1 maximum: 2147483647

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 As int64 As int64
max_new_connection_rate
Optional
Constraints: minimum: 1 maximum: 2147483647

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.

string
persistence_profile_id
Optional

Persistence profile is used to allow related client connections to be sent to the same backend server.

string
pool_id
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.

string As port-or-range As port-or-range
port
Optional

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.

array of string
ports
Optional
Constraints: maxItems: 14

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 string
rule_ids
Optional
Constraints: maxItems: 4000

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.

server_ssl_profile_binding
Optional

server_ssl_profile_binding

string
sorry_pool_id
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. The property is deprecated as NSX-T Load Balancer is deprecated.