PolicyLbPoolAccess (schema)

Defining access a Group from a PolicyLbVirtualServer and binding to PolicyLbMonitorProfile

Defining access of a Group from a PolicyLbVirtualServer and binding to
PolicyLbMonitorProfile.
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
algorithm Load balancing algorithm

Load balanding algorithm controls how the incoming
connections are distributed among the members.
- ROUND_ROBIN - requests to the application servers are distributed
in a round-robin fashion,
- LEAST_CONNECTION - next request is assigned to the server with the
least number of active connections
string Enum: ROUND_ROBIN, LEAST_CONNECTION
Default: "ROUND_ROBIN"
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
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
id Unique identifier of this resource string Sortable
ip_port_list IP Port list for applications within the Group

IP Port list for applications within the Group to allow
for non-uniform port usage by applications
array of IPAddressPortPair
lb_monitor_profile Path of the PolicyLbMonitorProfile to actively monitor the PolicyLbPoolAccess's Group

Path of the PolicyLbMonitorProfile to actively monitor the
PolicyLbPoolAccess's Group
string
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"
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_port Port for LoadBalancer to send traffic

Port for LoadBalancer to send connections to the PolicyLbPoolAccess's
Group. Pool_port could be optional, if it is not specified, LB will use
PolicyLbVirtualServer port to connect to backend servers. If the
PolicyLbMonitorProfile is configured in PolicyLbPoolAccess and active
monitor IP protocol is TCP/UDP(which requires TCP or UDP port number),
monitor_port should be specified if pool_port is unset.
int Minimum: 0
Maximum: 65535
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value PolicyLbPoolAccess string
source_nat Source NAT setting of the PolicyLbPoolAccess

Depending on the topology, Source NAT (SNAT) may be required to ensure
traffic from the server destined to the client is received by the load
balancer. SNAT can be enabled per pool. If SNAT is not enabled for a
pool, then load balancer uses the client IP and port (spoofing) while
establishing connections to the servers. This is referred to as no-SNAT
or TRANSPARENT mode. SNAT is enabled by default and will use the
load balancer interface IP and an ephemeral port as the source IP and
port of the server side connection.
string Enum: ENABLED, DISABLED
Default: "ENABLED"
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