Introduced : BIG-IP_v11.4.0
Gets the SessionDB entries associated with the specified keys. Subscriber ID or session IP could be the key. Subscriber ID takes precedence. The session IP is searched based on the subscriber ID first. If the result is not empty, the returned session IP is used as the key to search entries. If the result is empty, the user specified session IP is then used. Users must specify the keys; in other words, wildcard query is not supported.


SessionDBEntry [] [] get_sessiondb_entry(
    in PEM__Subscriber__SessionDBKey [] keys


Parameter Type Description
keys SessionDBKey [] The keys used to look up and retrieve the SessionDB entries.

Return Type

Type Description
SessionDBEntry [] [] The details of the SessionDB entries for the specified keys.


Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if one of the arguments is invalid.
Common::OperationFailed Raised if an operation error occurs.

See Also


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.