LBHttpProfile (schema)

Http profile

Http profile.
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
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
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
http_redirect_to Http redirect static URL

If a website is temporarily down or has moved, incoming requests
for that virtual server can be temporarily redirected to a URL.
http_redirect_to_https Flag to indicate whether enable HTTP-HTTPS redirect

Certain secure applications may want to force communication over SSL,
but instead of rejecting non-SSL connections, they may choose to
redirect the client automatically to use SSL.
boolean Default: "False"
id Unique identifier of this resource string Sortable
idle_timeout HTTP application idle timeout in seconds

It is used to specify the HTTP application idle timeout, it means that
how long the load balancer will keep the connection idle to wait for
the client to send the next keep-alive request. It is not a TCP socket
integer Minimum: 1
Maximum: 5400
Default: "15"
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"
ntlm NTLM support flag

NTLM is an authentication protocol that can be used over HTTP. If the
flag is set to true, LB will use NTLM challenge/response methodology.
This property is deprecated. Please use the property server_keep_alive
in order to keep the backend server connection alive for the client
When create a new profile, if both ntlm and server_keep_alive are set
as different values, ERROR will be reported.
When update an existing profile, if either ntlm or server_keep_alive
value is changed, both of them are updated with the changed value.
boolean Deprecated
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
relative_path Relative path of this object

Path relative from its parent
string Readonly
request_body_size Maximum size of the buffer used to store HTTP request body

If it is not specified, it means that request body size is unlimited.
integer Minimum: 1
Maximum: 2147483647
request_header_size Maximum size of the buffer used to store HTTP request headers

A request with header equal to or below this size is guaranteed to be
processed. A request with header larger than request_header_size will
be processed up to 32K bytes on best effort basis.
integer Minimum: 1
Default: "1024"
resource_type Must be set to the value LBHttpProfile LBApplicationProfileType Required
response_buffering Enable or disable buffering of responses

When buffering is disabled, the response is passed to a client
synchronously, immediately as it is received.
When buffering is enabled, LB receives a response from the backend
server as soon as possible, saving it into the buffers.
boolean Default: "False"
response_header_size Maximum size of the buffer used to store HTTP response headers

A response with header larger than response_header_size will be dropped.
integer Minimum: 1
Maximum: 65536
Default: "4096"
response_timeout Maximum server idle time in seconds

If server doesn’t send any packet within this time, the connection is closed.
integer Minimum: 1
Maximum: 2147483647
Default: "60"
server_keep_alive Server keep-alive flag

If server_keep_alive is true, it means the backend connection will keep
alive for the client connection. Every client connection is tied 1:1
with the corresponding server-side connection.
If server_keep_alive is false, it means the backend connection won't
keep alive for the client connection.
If server_keep_alive is not specified for API input, its value in API
output will be the same with the property ntlm.
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
x_forwarded_for Insert or replace x_forwarded_for

When X-Forwareded-For is configured, X-Forwarded-Proto and
X-Forwarded-Port information is added automatically. The two additional
header information can be also modified or deleted in load balancer