LBVirtualServer (schema)

Base class for each type of LBVirtualServer

All the types of LBVirtualServer extend from this abstract class. This
is present for extensibility.
Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
_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
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.
_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.
access_log_enabled Access log enabled setting

If access log is enabled, all HTTP requests sent to L7 virtual server
are logged to the access log file. Both successful returns information
responses(1xx), successful responses(2xx), redirection messages(3xx) and
unsuccessful requests, backend server returns 4xx or 5xx, are logged to
access log, if enabled. All L4 virtual server connections are also
logged to the access log if enabled. The non-significant events such as
successful requests are not logged if log_significant_event_only is set
to true.
boolean Default: "False"
application_profile_path Application profile path

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
children subtree for this type within policy tree

subtree for this type within policy tree containing nested elements.
array of ChildPolicyConfigResource
Children are not allowed for this type
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
default_pool_member_ports Default pool member ports when member port is not defined.

Default pool member ports when member port is not defined.
array of PortElement Maximum items: 14
description Description of this resource string Maximum length: 1024
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
enabled whether the virtual server is enabled

Flag to enable the load balancer virtual server.
boolean Default: "True"
id Unique identifier of this resource string Sortable
ip_address IP address of the LBVirtualServer

Configures the IP address of the LBVirtualServer where it
receives all client connections and distributes them among the
backend servers.
IPAddress Required
lb_persistence_profile_path Persistence Profile used by LBVirtualServer

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.
lb_service_path Path to LBService object for LBVirtualServer

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.
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"
marked_for_delete Indicates whether the intent object is marked for deletion

Intent objects are not directly deleted from the system when a delete
is invoked on them. They are marked for deletion and only when all the
realized entities for that intent object gets deleted, the intent object
is deleted. Objects that are marked for deletion are not returned in
GET call. One can use the search API to get these objects.
boolean Readonly
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.
integer Minimum: 1
Maximum: 2147483647
max_new_connection_rate Maximum new connection rate in connections per 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.
integer Minimum: 1
Maximum: 2147483647
overridden Indicates whether this object is the overridden intent object

Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
boolean Readonly
Default: "False"
parent_path Path of its parent

Path of its parent
string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
pool_path Default server pool path

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.
ports Virtual server port number(s) or port range(s)

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.
array of PortElement Required
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value LBVirtualServer string
rules List of load balancer rules

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.
array of LBRule 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.
sorry_pool_path Sorry server pool path

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.
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
unique_id A unique identifier assigned by the system

This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
string Readonly