ILX::init

Description

Creates a handle for future use by ILX::call and ILX::notify. This handle is a reference to a running ILX plugin extension. The lifetime of this variable affects the behavior of the ILX target if controlled by BIG-IP. Instances of the plugin extension will be held in draining mode as long as there are open references to the ILX handle in any event.
Note: Whereas the ILX commands were introduced in 12.0, they were not available until 12.1 without an EA license.

Warning

Deprecated in BIG-IP Next v20.0.1

Syntax

ILX::init [plugin name] [extension name]

Valid During

ANY_EVENT with the exception of RULE_INIT

Examples

when CLIENT_ACCEPTED {
     # Get a handle to the running extension instance to call into.
     set RPC_HANDLE [ILX::init my_plugin my_extension]
     # Make the call and store the response in $rpc_response
     set rpc_response [ILX::call $RPC_HANDLE my_js_function arg1 arg2]
 }

Change Log

  • Introduced: BIGIP-12.0
  • Deprecated: BIGIP-20.0.1

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.