LocalLB::ProfileOneConnect¶
Introduced : BIG-IP_v9.0
The ProfileOneConnect interface enables you to manipulate a local load
balancer&aposs OneConnect profile.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified OneConnect profiles. | BIG-IP_v9.0 |
| delete_all_profiles | Deletes all OneConnect profiles. | BIG-IP_v9.0 |
| delete_profile | Deletes the specified OneConnect profiles. | BIG-IP_v9.0 |
| get_all_statistics | Gets the statistics for all the OneConnect 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 OneConnect profiles. | BIG-IP_v11.0.0 |
| get_idle_timeout | Gets the idle timeouts for connections in the specified connection pools. | BIG-IP_v9.0 |
| get_limit_type | Gets the limit types for OneConnect profiles. | BIG-IP_v11.6.0 |
| get_list | Gets a list of all OneConnect profiles. | BIG-IP_v9.0 |
| get_maximum_age | Gets the maximum age (in seconds) after which a connection should not be reused. | BIG-IP_v9.0 |
| get_maximum_connection | Gets the maximum number of connections for the specified OneConnect profiles. | BIG-IP_v9.0 |
| get_maximum_reuse | Gets the maximum times the connections in the pool can be reused. | BIG-IP_v9.0 |
| get_share_pools_state | Gets the share pools flags for OneConnect profiles. | BIG-IP_v11.6.0 |
| get_source_mask | Gets the masks applied to the source addresses to determine eligibility for connection reuse. | BIG-IP_v9.0 |
| get_statistics | Gets the statistics for the specified OneConnect profiles. | BIG-IP_v9.0 |
| get_statistics_by_virtual | Gets the statistics for the specified profiles, by virtual server. | BIG-IP_v11.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| is_base_profile | Determines whether the specified OneConnect 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 OneConnect 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 |
| reset_statistics | Resets the statistics for the specified OneConnect profiles. | BIG-IP_v9.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified profiles, for specified virtual servers. | BIG-IP_v11.0.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 OneConnect profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_idle_timeout | Sets the idle timeouts for connections in the specified connection pools. | BIG-IP_v9.0 |
| set_limit_type | Sets the limit types for OneConnect profiles. The limit-type can take on one of three values: ONECONNECT_LIMIT_TYPE_NONE (none), ONECONNECT_LIMIT_TYPE_IDLE (idle), ONECONNECT_LIMIT_TYPE_STRICT (strict). none: behaviour is as before, “connections” are counted toward the pool member limit based on whether they have active, in-flight, requests or responses. idle: if a client connection is accepted and we are at or above the TCP connection limit, a random idle connection will be dropped. strict: a hard TCP pool member connection limit is enforced. No attempt will be made to try to find a connection to reuse if at the TCP connection limit, EVEN IF ONE MIGHT BE AVAILABLE. This mode of operation is not recommended (though some customers find it useful with short idle connection timeouts). | BIG-IP_v11.6.0 |
| set_maximum_age | Sets the maximum age (in seconds) after which a connection should not be reused. | BIG-IP_v9.0 |
| set_maximum_connection | Sets the maximum number of connections for the specified OneConnect profiles. | BIG-IP_v9.0 |
| set_maximum_reuse | Sets the maximum times the connections in the pool can be reused. | BIG-IP_v9.0 |
| set_share_pools_state | Sets the share pools flags for OneConnect profiles. If the share_pools flag is set on a OneConnect profile, hudchains with hudnodes related to OneConnect filters that share the same sequence of filters from the OneConnect filter to the chain end can be shared in a OneConnect pool. | BIG-IP_v11.6.0 |
| set_source_mask | Sets the masks applied to the source addresses to determine eligibility for connection reuse. | BIG-IP_v9.0 |
Structures¶
Structure
Description
A struct that describes LimitType settings and their default status.
ProfileOneConnectStatisticEntry
A struct that describes statistics for a particular OneConnect profile.
A struct that describes profile statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| LimitType | An enum that encapsulates the connection limit limit types. |
Aliases¶
| Alias | Type | Description |
| ProfileLimitTypeSequence | ProfileLimitType [] | A sequence of LimitType types. |
| ProfileOneConnectStatisticEntrySequence | ProfileOneConnectStatisticEntry [] | A sequence of ProfileOneConnect statistics. |
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.