LocalLB::ProfilePersistence¶
Introduced : BIG-IP_v9.0
The ProfilePersistence interface enables you to manipulate a local
load balancer&aposs Persistence profile.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified Persistence profiles. | BIG-IP_v9.0 |
| delete_all_profiles | Deletes all Persistence profiles. | BIG-IP_v9.0 |
| delete_profile | Deletes the specified Persistence profiles. | BIG-IP_v9.0 |
| get_across_pool_state | Gets the states to indicate whether persistence entries added under this profile are available across pools. | BIG-IP_v9.0 |
| get_across_service_state | Gets the states to indicate whether persistence entries added under this profile are available across services. | BIG-IP_v9.0 |
| get_across_virtual_state | Gets the states to indicate whether persistence entries added under this profile are available across virtuals. | BIG-IP_v9.0 |
| get_cookie_always_send_state | Gets the state indicating, when enabled, that the cookie persistence entry will be sent to the client on every response, rather than only on the first response. The default value is disabled. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE. | BIG-IP_v11.5.0 |
| get_cookie_encryption | Gets the cookie encryption types for Persistence profiles. | BIG-IP_v11.6.0 |
| get_cookie_encryption_passphrase | Gets the encrypted cookie encryption passphrases for the specified Persistence profiles. These are encrypted and generally of little use except for verifying they have not changed. | BIG-IP_v11.6.0 |
| get_cookie_expiration | Gets the cookie expiration in seconds for the specified Persistence profiles. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE. | BIG-IP_v9.0 |
| get_cookie_hash_length | Gets the cookie hash lengths for the specified profiles. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH. | BIG-IP_v9.0 |
| get_cookie_hash_offset | Gets the cookie hash offsets for the specified profiles. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH. | BIG-IP_v9.0 |
| get_cookie_httponly_attribute | Gets the cookie&aposs HTTPonly attribute state for the specified profiles. | BIG-IP_v9.0 |
| get_cookie_name | Gets the cookie names for the specified Persistence profiles. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE. | BIG-IP_v9.0 |
| get_cookie_persistence_method | Gets the cookie persistence methods to be used when in cookie persistence mode. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE. | BIG-IP_v9.0 |
| get_cookie_secure_attribute | Gets the cookie&aposs Secure attribute state for the specified profiles. | BIG-IP_v9.0 |
| get_default_profile | Gets the names of the default profiles from which the specified profiles will derive default values for its attributes. | BIG-IP_v9.0 |
| get_description | Gets the descriptions for a set of persistence profiles. | BIG-IP_v11.0.0 |
| get_ending_hash_pattern | Gets the pattern marking the end of the section of payload data whose hashed value is used for the persistence value for a set of persistence profiles. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| get_hash_length | Gets the length of payload data whose hashed value is used for the persistence value for a set of persistence profiles. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| get_hash_method | Gets the hash method used to generate the persistence values for a set of persistence profiles. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH. | BIG-IP_v10.1.0 |
| get_hash_more_data_state | Gets the enabled state whether to perform another hash operation after the current hash operation completes for a set of persistence profiles. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| get_hash_offset | Gets the offset to the start of the payload data whose hashed value is used as the persistence value for a set of persistence profiles. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| get_list | Gets a list of all Persistence profiles. | BIG-IP_v9.0 |
| get_map_proxy_address | Gets the proxy map address used when map proxies state is enabled on source address persistence mode. | BIG-IP_v11.0.0 |
| get_map_proxy_class | Gets the proxy map IP address class/datagroup name used when map known proxies state is enabled on source address persistence mode. | BIG-IP_v11.0.0 |
| get_map_proxy_state | Gets the states to indicate whether to map known proxies when the persistence mode is source address affinity. | BIG-IP_v9.0 |
| get_mask | Gets the masks used in either simple or sticky persistence mode. | BIG-IP_v9.0 |
| get_maximum_hash_buffer_size | Gets the maximum size of the buffer used to hold the section of the payload data whose hashed value is used for the persistence value for a set of persistence values. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| get_mirror_state | Gets the mirror states for the specified Persistence profiles. | BIG-IP_v9.0 |
| get_msrdp_without_session_directory_state | Gets the states to indicate whether MS terminal services have been configured without a session directory for the specified Persistence profiles. | BIG-IP_v9.0 |
| get_override_connection_limit_state | Gets the state indicating, when enabled, that the pool member connection limits are not enforced for persisted clients. | BIG-IP_v11.0.0 |
| get_persistence_mode | Gets the persistence modes for the specified Persistence profiles. | BIG-IP_v9.0 |
| get_rule | Gets the UIE rules for the specified Persistence profiles. Applicable when persistence mode is PERSISTENCE_MODE_UIE. | BIG-IP_v9.0 |
| get_sip_info | Gets the sip_info headers for the specified Persistence profiles. Applicable when persistence mode is PERSISTENCE_MODE_SIP. | BIG-IP_v9.4.2 |
| get_starting_hash_pattern | Gets the pattern marking the start of the section of payload data whose hashed value is used for the persistence value for a set of persistence profiles. This only returns useful values if the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| get_timeout | Gets the timeout for the specified Persistence profiles. The number of seconds to timeout a persistence entry. | BIG-IP_v9.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| is_base_profile | Determines whether the specified persistence profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). | BIG-IP_v9.0 |
| is_system_profile | Determines whether the specified persistence profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). | BIG-IP_v11.0.0 |
| set_across_pool_state | Sets the states to indicate whether persistence entries added under this profile are available across pools. | BIG-IP_v9.0 |
| set_across_service_state | Sets the states to indicate whether persistence entries added under this profile are available across services. | BIG-IP_v9.0 |
| set_across_virtual_state | Sets the states to indicate whether persistence entries added under this profile are available across virtuals. | BIG-IP_v9.0 |
| set_cookie_always_send_state | Sets the state indicating, when enabled, that the cookie persistence entry will be sent to the client on every response, rather than only on the first response. The default value is disabled. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE. | BIG-IP_v11.5.0 |
| set_cookie_encryption | Sets the cookie encryption types for Persistence profiles. See CookieEncryption for more details. | BIG-IP_v11.6.0 |
| set_cookie_encryption_passphrase | Sets the cookie encryption passphrases for the specified Persistence profiles. These are used when the persistence mode is PERSISTENCE_MODE_COOKIE and cookie encryption is required or preferred. | BIG-IP_v11.6.0 |
| set_cookie_expiration | Sets the cookie expiration in seconds for the specified Persistence profiles. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE. | BIG-IP_v9.0 |
| set_cookie_hash_length | Sets the cookie hash lengths for the specified profiles. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH. | BIG-IP_v9.0 |
| set_cookie_hash_offset | Sets the cookie hash offsets for the specified profiles. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE, and cookie persistence method is COOKIE_PERSISTENCE_METHOD_HASH. | BIG-IP_v9.0 |
| set_cookie_httponly_attribute | Sets the cookie&aposs HTTPonly attribute state for the specified profiles. When enabled, sets the value of the httponly attribute for inserted cookies in HTTP response. This is applicable only when the profile has persistence mode of PERSISTENCE_MODE_COOKIE and a cookie persistence method of COOKIE_PERSISTENCE_METHOD_INSERT. | BIG-IP_v9.0 |
| set_cookie_name | Sets the cookie names for the specified Persistence profiles. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE. | BIG-IP_v9.0 |
| set_cookie_persistence_method | Sets the cookie persistence methods to be used when in cookie persistence mode. Applicable when persistence mode is PERSISTENCE_MODE_COOKIE. | BIG-IP_v9.0 |
| set_cookie_secure_attribute | Sets the cookie&aposs Secure attribute state for the specified profiles. When enabled, sets the value of the secure attribute for inserted cookies in HTTP response. This is applicable only when the profile has persistence mode of PERSISTENCE_MODE_COOKIE and a cookie persistence method of COOKIE_PERSISTENCE_METHOD_INSERT. | BIG-IP_v9.0 |
| set_default_profile | Sets the names of the default profiles from which the specified profiles will derive default values for its attributes. | BIG-IP_v9.0 |
| set_description | Sets the description for a set of persistence profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_ending_hash_pattern | Sets the pattern marking the end of the section of payload data whose hashed value is used for the persistence value for a set of persistence profiles. The hash payload data is either delimited by this starting and ending string pattern or the offset and length, not both. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| set_hash_length | Sets the length of payload data whose hashed value is used for the persistence value for a set of persistence profiles. The start of the data is specified via set_hash_offset. The hash payload data is either delimited by this offset and length or the starting and ending string pattern, not both. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| set_hash_method | Sets the hash method used to generate the persistence values for a set of persistence profiles. See PersistenceHashMethod for details. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH. | BIG-IP_v10.1.0 |
| set_hash_more_data_state | Sets the enabled state whether to perform another hash operation after the current hash operation completes for a set of persistence profiles. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| set_hash_offset | Sets the offset to the start of the payload data whose hashed value is used as the persistence value for a set of persistence profiles. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. The hashed payload data length is specified via set_hash_length. | BIG-IP_v10.1.0 |
| set_map_proxy_address | Sets the mapped address that is used when the map proxies state is enabled and the source address matches the map proxy class. When this is not set, an address from the data-group/class is used. | BIG-IP_v11.0.0 |
| set_map_proxy_class | Sets the data-group/class that is searched to determine whether a source address is behind a proxy and should then be mapped. This is only relevant when the map proxies state is enabled on a source address persistence profile. If this is not set when the map proxy state is enabled, then the data-group/class defined by the DB variable “Persist.WellKnownProxyClass” will be used. | BIG-IP_v11.0.0 |
| set_map_proxy_state | Sets the states to indicate whether to map known proxies when the persistence mode is source address affinity. | BIG-IP_v9.0 |
| set_mask | Sets the masks used in either simple or sticky persistence mode. | BIG-IP_v9.0 |
| set_maximum_hash_buffer_size | Sets the maximum size of the buffer used to hold the section of the payload data whose hashed value is used for the persistence value for a set of persistence values. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| set_mirror_state | Sets the mirror states for the specified Persistence profiles. | BIG-IP_v9.0 |
| set_msrdp_without_session_directory_state | Sets the states to indicate whether MS terminal services have been configured without a session directory for the specified Persistence profiles. | BIG-IP_v9.0 |
| set_override_connection_limit_state | Sets the state indicating, when enabled, that the pool member connection limits are not enforced for persisted clients. Per-virtual connection limits remain hard limits and are not disabled. The default value is disabled. | BIG-IP_v11.0.0 |
| set_persistence_mode | Sets the persistence modes for the specified Persistence profiles. | BIG-IP_v9.0 |
| set_rule | Sets the UIE rules for the specified Persistence profiles. Applicable when persistence mode is PERSISTENCE_MODE_UIE. | BIG-IP_v9.0 |
| set_sip_info | Sets the sip_info header for the specified Persistence profiles. Applicable when persistence mode is PERSISTENCE_MODE_SIP. | BIG-IP_v9.4.2 |
| set_starting_hash_pattern | Sets the pattern marking the start of the section of payload data whose hashed value is used for the persistence value for a set of persistence profiles. This is only applicable when the persistence mode is PERSISTENCE_MODE_HASH and the hash method is PERSISTENCE_HASH_CARP. | BIG-IP_v10.1.0 |
| set_timeout | Sets the timeout for the specified Persistence profiles. The number of seconds to timeout a persistence entry. | BIG-IP_v9.0 |
Structures¶
Structure
Description
A struct that describes CookieEncryption settings and their default status.
A structure that specifies the persistence hash method for profiles
Enumerations¶
| Enumeration | Description |
| CookieEncryption | An enum that encapsulates the persistence cookie encryption types. |
| PersistenceHashMethod | Persistence hash methods used for persisting connections |
Aliases¶
| Alias | Type | Description |
| PersistenceHashMethodSequence | PersistenceHashMethod [] | Sequence of persistence hash methods |
| ProfileCookieEncryptionSequence | ProfileCookieEncryption [] | A sequence of CookieEncryption types. |
| ProfilePersistenceHashMethodSequence | ProfilePersistenceHashMethod [] | Sequence of persistence hash methods |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.