ILXPluginOptions

new ILXPluginOptions()

Since:
  • BIP-IP TMOS 13.0
The set of configurable plugin options that are passed to the ILXPlugin constructor.

Properties:

Name Type Default Description
handleClient

Open

boolean false Enabling this option causes the system to delay connecting to the server until one of the following occurs: a) the plugin calls ILXFlow.client. allow, or, b) the plugin writes data to the server via ILXFlow.server. write. The plugin may read data from the client using ILXFlow.client. on (‘data’, …), allowing the plugin to validate client parameters before either rejecting the client connection, allowing the connection to the server to proceed, or making a custom load balancing decision.
handleClient

Data

boolean true

This must be enabled to receive data on a flows’ client stream (data from the client). See also ` <ILXFlow.html #detach>`__

ILXFlow#deta

ch

. This value should be disabled if the plugin does not need to inspect or modify data from the client, resulting in better performance.

handleServer

Data

boolean true

This must be enabled to receive data on a flows’ server stream (data from the server). See also ` <ILXFlow.html #detach>`__

ILXFlow#deta

ch

. This value should be disabled if the plugin does not need to inspect or modify data from the server, resulting in better performance.

handleClient

Request

boolean true

This option is applicable if the virtual server has an HTTP profile. This option enables the capability to a) receive and inspect client HTTP request headers, and b) replace the client request transaction (headers, body or both). To manage an HTTP client request the virtual server must be configure with ILX ( and HTTP profiles. See also ` <ILXStream.ht ml#event:reques tStart>`__

ILXStream#ev

ent:requestStar t

.

handleServer

Response

boolean true

This option is applicable if the virtual server has an HTTP profile. This option enables the capability to a) receive and inspect client HTTP response headers, and b) replace the server response transaction (headers, body or both). To manage an HTTP server response the virtual server must be configure with ILX and HTTP profiles. See also ` <ILXStream.ht ml#event:respon seStart>`__

ILXStream#ev

ent:responseSta rt

.

disableServe

r

boolean false

Disable the socket ILXFlow.server. This is useful if the plugin will only interact with the client or the plugin is started with ` <ILXPlugin.ht ml#startHttpSer ver>`__

ILXPlugin#st

artHttpServer

. Note that this will automatically enable handleClientOpe n.

Example:

 var options = new f5.ILXPluginOptions();
options.disableServer = true;
plugin.start(options);

<p>*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.*</p>