ILXLbOptions

new ILXLbOptions()

Since:
  • BIP-IP TMOS 13.0

The set of options available for specifying the load balancing selection for a connection. Note that for a load balancing selection to be made the plugin must enable the plugin option ILXPluginOptions.handleClientOpen and not write any data to the server stream ILXFlow.server until after the load balancing selection has been made.

The options have the following precedence.

  • The system will load balance to the specified virtual server.
  • The system will load balance to the specified pool.
  • If neither a virtual server or pool are specified then the system will connect to the specified remote address.
  • If includeVirtualServers is enabled then a virtual server may be specified in the remote address settings.

Properties:

Name Type Attributes Default Description
virtualS

erver

string <optional> none LTM virtual server name. The name must be a fully qualified path name, e.g., /Common/.
pool
string <optional> none LTM pool name. The name must be a fully qualified path name, e.g., /Common/
remote
object    

Properties :name: p

roperties-1

+—+—+– -+—+—+ | N | T | A

D | D |
a | y | t | e | e |
m | p | t | f | s |
e | e | r | a | c |
| | i | u | r |
| | b | l | i |
| | u | t | p |
| | t | | t |
| | e | | i |
| | s | | o |
| | | | n |

+===+===+== =+===+===+ | : | s | <

n | C |
: | t | o | o | o |
| r | p | n | n |
| i | t | e | n |
| n | i | | e |
| g | o | | c |
a | | n | | t |
d | | a | | t |
d | | l | | o |
r | | > | | t |
e | | | | h |
s | | | | e |
s | | | | s |
| | | | p |
| | | | e |
| | | | c |
| | | | i |
| | | | f |
| | | | i |
| | | | e |
| | | | d |
| | | | I |
| | | | P |
| | | | a |
| | | | d |
| | | | d |
| | | | r |
| | | | e |
| | | | s |
| | | | s |
| | | | . |
| | | | T |
| | | | h |
| | | | e |
| | | | a |
| | | | d |
| | | | d |
| | | | r |
| | | | e |
| | | | s |
| | | | s |
| | | | m |
| | | | a |
| | | | y |
| | | | c |
| | | | o |
| | | | n |
| | | | t |
| | | | a |
| | | | i |
| | | | n |
| | | | a |
| | | | r |
| | | | o |
| | | | u |
| | | | t |
| | | | e |
| | | | d |
| | | | o |
| | | | m |
| | | | a |
| | | | i |
| | | | n |
| | | | , |
| | | | e |
| | | | x |
| | | | a |
| | | | m |
| | | | p |
| | | | l |
| | | | e |
| | | | : |
| | | | 1 |
| | | | 0 |
| | | | . |
| | | | 1 |
| | | | . |
| | | | 1 |
| | | | . |
| | | | 1 |
| | | | % |
| | | | 2 |
| | | | 2 |

+—+—+– -+—+—+ | : | n | <

0 | R |
: | u | o | | e |
| m | p | | m |
| b | t | | o |
| e | i | | t |
| r | o | | e |
p | | n | | p |
o | | a | | o |
r | | l | | r |
t | | > | | t |
| | | | . |

+—+—+– -+—+—+

includeV

irtualServe rs

boolean <optional> false Indicates that remote.addr ess may be an LTM virtual server.

<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>