System::Connections

Introduced : BIG-IP_v9.0
The Connections interface enables you to get information about a device&aposs connections. For example, use Connection interface to get a list of all active connections or to get a list of all active connections for a specific client.

Methods

Method Description Introduced
delete_active_connection Deletes the specified connections from the connection table. BIG-IP_v9.0
delete_all_active_connections Deletes all active connections from the connection table. BIG-IP_v9.0
get_active_connection Gets the active connections in detail for the specified connections. If some of the connections requested no longer exist (or never existed), the system skips them and returns the entries it can, in which case the result sequence will be shorter than the input sequence and you can check the key fields in the result to see which connections exist. BIG-IP_v9.0
get_active_connection_v2 Gets the active connections in detail for the specified connections. If some of the connections requested no longer exist (or never existed), the system skips them and returns the entries it can, in which case the result sequence will be shorter than the input sequence and you can check the key fields in the result to see which connections exist. BIG-IP_v11.0.0
get_all_active_connections Gets all active connections in details on the local load balancer. BIG-IP_v9.0
get_all_active_connections_v2 Gets all active connections in details on the local load balancer. BIG-IP_v11.0.0
get_list Gets the list of active connections. BIG-IP_v9.0
get_version Gets the version information for this interface. BIG-IP_v9.0

Structures

Structure

Description

ActiveConnection

This structure is deprecated, because unit IDs have been replaced by traffic groups. A struct that describes a device&aposs active connections in details.

ActiveConnectionV2

A struct that describes a device&aposs active connections in details.

ConnectionID

A struct that identifies a connection.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ActiveConnectionSequence ActiveConnection [] A list of active connections for the device.
ActiveConnectionV2Sequence ActiveConnectionV2 [] A list of active connections for the device.
ConnectionIDSequence ConnectionID [] A list of connection IDs.

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.