LbSourceIpPersistenceProfile (schema)

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

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

ha_persistence_mirroring_enabled mirroring enabled flag to synchronize persistence entries

Persistence entries are not synchronized to the HA peer by default.
boolean Default: "False"

id Unique identifier of this resource string Sortable

persistence_shared Persistence shared flag

The persistence shared flag identifies whether the persistence table
is shared among virtual-servers referring this profile.
If persistence shared flag is not set in the cookie persistence profile
bound to a virtual server, it defaults to cookie persistence that is
private to each virtual server and is qualified by the pool. This is
accomplished by load balancer inserting a cookie with name in the
format <name>.<virtual_server_id>.<pool_id>.
If persistence shared flag is set in the cookie persistence profile, in
cookie insert mode, cookie persistence could be shared across multiple
virtual servers that are bound to the same pools. The cookie name would
be changed to <name>.<profile-id>.<pool-id>.
If persistence shared flag is not set in the sourceIp persistence
profile bound to a virtual server, each virtual server that the profile
is bound to maintains its own private persistence table.
If persistence shared flag is set in the sourceIp persistence profile,
all virtual servers the profile is bound to share the same persistence
table.
If persistence shared flag is not set in the generic persistence
profile, the persistence entries are matched and stored in the table
which is identified using both virtual server ID and profile ID.
If persistence shared flag is set in the generic persistence profile,
the persistence entries are matched and stored in the table which is
identified using profile ID. It means that virtual servers which
consume the same profile in the LbRule with this flag enabled are
sharing the same persistence table.
boolean Default: "False"

purge persistence purge setting SourceIpPersistencePurge Default: "FULL"

resource_type Must be set to the value LbSourceIpPersistenceProfile PersistenceProfileType Required

tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

timeout persistence entry expiration time in seconds

When all connections complete (reference count reaches 0), persistence
entry timer is started with the expiration time.
integer Minimum: 1
Maximum: 2147483647
Default: "300"

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
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
ha_persistence_mirroring_enabled	mirroring enabled flag to synchronize persistence entries Persistence entries are not synchronized to the HA peer by default.	boolean	Default: "False"
id	Unique identifier of this resource	string	Sortable
persistence_shared	Persistence shared flag The persistence shared flag identifies whether the persistence table is shared among virtual-servers referring this profile. If persistence shared flag is not set in the cookie persistence profile bound to a virtual server, it defaults to cookie persistence that is private to each virtual server and is qualified by the pool. This is accomplished by load balancer inserting a cookie with name in the format <name>.<virtual_server_id>.<pool_id>. If persistence shared flag is set in the cookie persistence profile, in cookie insert mode, cookie persistence could be shared across multiple virtual servers that are bound to the same pools. The cookie name would be changed to <name>.<profile-id>.<pool-id>. If persistence shared flag is not set in the sourceIp persistence profile bound to a virtual server, each virtual server that the profile is bound to maintains its own private persistence table. If persistence shared flag is set in the sourceIp persistence profile, all virtual servers the profile is bound to share the same persistence table. If persistence shared flag is not set in the generic persistence profile, the persistence entries are matched and stored in the table which is identified using both virtual server ID and profile ID. If persistence shared flag is set in the generic persistence profile, the persistence entries are matched and stored in the table which is identified using profile ID. It means that virtual servers which consume the same profile in the LbRule with this flag enabled are sharing the same persistence table.	boolean	Default: "False"
purge	persistence purge setting	SourceIpPersistencePurge	Default: "FULL"
resource_type	Must be set to the value LbSourceIpPersistenceProfile	PersistenceProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	persistence entry expiration time in seconds When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time.	integer	Minimum: 1 Maximum: 2147483647 Default: "300"