| _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 |
| app_cookie_persistence_profile |
App cookie persistence profile
Specifies the Application Cookie Persistence profile
parameters.
|
ALBAppCookiePersistenceProfile |
|
| 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 |
| hdr_persistence_profile |
Hdr persistence profile
Specifies the custom HTTP Header Persistence profile
parameters.
|
ALBHdrPersistenceProfile |
|
| http_cookie_persistence_profile |
Http cookie persistence profile
Specifies the HTTP Cookie Persistence profile parameters. |
ALBHttpCookiePersistenceProfile |
|
| id |
Unique identifier of this resource |
string |
Sortable |
| ip_persistence_profile |
Ip persistence profile
Specifies the Client IP Persistence profile parameters. |
ALBIPPersistenceProfile |
|
| is_federated |
Is federated
This field describes the object's replication scope.
If the field is set to false, then the object is visible
within the controller-cluster and its associated
service-engines.
If the field is set to true, then the object is replicated
across the federation.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
|
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" |
| 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 |
| persistence_type |
Persistence type
Method used to persist clients to the same server for a
duration of time or a session.
Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,
PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS,
PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS,
PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER,
PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE.
Default value when not specified in API or module is
interpreted by ALB Controller as
PERSISTENCE_TYPE_CLIENT_IP_ADDRESS.
|
ALBPersistenceProfileType |
Required
Default: "PERSISTENCE_TYPE_CLIENT_IP_ADDRESS" |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| resource_type |
Must be set to the value ALBApplicationPersistenceProfile |
string |
|
| server_hm_down_recovery |
Server hm down recovery
Specifies behavior when a persistent server has been marked
down by a health monitor.
Enum options - HM_DOWN_PICK_NEW_SERVER,
HM_DOWN_ABORT_CONNECTION,
HM_DOWN_CONTINUE_PERSISTENT_SERVER.
Default value when not specified in API or module is
interpreted by ALB Controller as HM_DOWN_PICK_NEW_SERVER.
|
ALBPersistentServerHMDownRecovery |
Default: "HM_DOWN_PICK_NEW_SERVER" |
| 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 |