System::CryptoClient

Introduced : BIG-IP_v11.6.0
The CryptoClient interface enables a user to manage remote crypto clients. A crypto client is used to establish a session with a remote server that provides cryptographic services. Generally, this is beneficial when the server is using hardware acceleration to perform said services faster than if it was done locally.

Methods

Method Description Introduced
add_profile Adds ServerSSL and TCP profiles to the specified crypto clients. See LocalLB::ProfileServerSSL or LocalLB::ProfileTCP for more details. BIG-IP_v11.6.0
create Creates the specified crypto clients. BIG-IP_v11.6.0
delete_all_clients Deletes all crypto clients. BIG-IP_v11.6.0
delete_client Deletes the specified crypto clients. BIG-IP_v11.6.0
get_all_statistics Gets the statistics for all crypto clients. BIG-IP_v11.6.0
get_enabled_state Gets the enabled state for the specified clients. BIG-IP_v12.1.0
get_heartbeat_interval Gets the heartbeat interval for the specified clients. BIG-IP_v11.6.0
get_list Gets the list of all crypto clients. BIG-IP_v11.6.0
get_maximum_retries Gets the maximum number of retries for the specified clients. BIG-IP_v11.6.0
get_profile Gets the list of profiles for the specified crypto clients. BIG-IP_v11.6.0
get_request_timeout Gets the request timeout for the specified clients. BIG-IP_v11.6.0
get_retry_interval Gets the retry interval for the specified clients. BIG-IP_v11.6.0
get_server_address Gets the server IP address for the specified clients. BIG-IP_v11.6.0
get_server_port Gets the server port number for the specified clients. BIG-IP_v11.6.0
get_statistics Gets the statistics for the specified crypto clients. BIG-IP_v11.6.0
get_version Gets the version information for this interface. BIG-IP_v11.6.0
remove_all_profiles Removes all profiles from the specified crypto clients. BIG-IP_v11.6.0
remove_profile Removes profiles from the specified crypto clients. BIG-IP_v11.6.0
reset_connection Resets the connection to the crypto server for the specified clients. This forces each client to close any existing connection and then reconnect to its associated crypto server. BIG-IP_v11.6.0
reset_statistics Resets the statistics for the specified crypto clients. BIG-IP_v11.6.0
set_enabled_state Sets the enabled state for the specified clients. BIG-IP_v12.1.0
set_heartbeat_interval Sets the heartbeat intervals for the specified clients. This is the time in seconds between sending heartbeat requests, which defaults to 30 seconds. A value of 0 disables sending heartbeats. BIG-IP_v11.6.0
set_maximum_retries Sets the maximum number of times to retry connecting to the remote crypto server. Once the retry limit is reached, the client is left unusable until the connection is reset via the reset_connection method to trigger the connection process. The default value of 65535 denotes unlimited retries. BIG-IP_v11.6.0
set_request_timeout Sets the request timeout for the specified clients. This sets the timeout in milliseconds for each cryptographic request to finish, with a default of 5000 milliseconds. BIG-IP_v11.6.0
set_retry_interval Sets the retry interval for the specified clients. This sets the time in seconds between each attempt to reconnect to the remote crypto server. The default is 10 seconds. BIG-IP_v11.6.0
set_server_address Sets the server IP address of the specified clients. BIG-IP_v11.6.0
set_server_port Sets the server port number for the specified clients. BIG-IP_v11.6.0

Structures

Structure

Description

CryptoClientStatisticEntry

A struct that describes statistics for a crypto client.

CryptoClientStatistics

A struct that describes crypto client statistics and timestamp.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
CryptoClientStatisticEntrySequence CryptoClientStatisticEntry [] A sequence of crypto client statistics.

See Also

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.