Management::EM::get_context_id

Introduced : BIG-IP_v9.0
Use the get_context_id API to retrieve a unique context ID. The context ID serves as a unique identifier that the iControl web proxy can use either for client/user session management, or for interaction with one specific BIG-IP device at a time.

Prototype

String get_context_id(

);

Parameters

Parameter Type Description

Return Type

Type Description
String The unique context ID string returned by the get_context_id API is a globally unique identifier (GUID).

Exceptions

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

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.