ILXDatagroup¶

new ILXDatagroup()

Since:

BIP-IP TMOS 13.0

ILXDatagroup class provides an API for accessing datagroups similar to the similar to

class

commands in iRules TCL. See class documentation on Dev Central for more information.

Example:

 var dg = {};
plugin.on('initialized', function () {
  dg = plugin.getDataGroup('/Common/some_dg');
}

// Block IP addresses in data group
plugin.on('connect', function(flow) {
  if (dg.lookup(flow.client.remoteAddress)) {
    console.log('Blocked conflow from "' + flow.client.remoteAddress + '".');
    flow.end();
  }
});

Members¶

(readonly)Options:number¶

Member for

options.return

argument used in many

ILXDatagroup

methods

Type:¶

number

Properties:¶

Name	Type	Description
NAME	number	Changes the return value to be the name of the class element of type string
VALUE	number	Changes the return value to be the value of the class element of type string
ELEMENT	number	Changes the return value to be an object containing both name and value

Name

Type

Description

NAME

number

Changes the return value to be the name of the class element of type

string

VALUE

number

Changes the return value to be the value of the class element of type

string

ELEMENT

number

Changes the return value to be an

object

containing both name and value

Example¶

 // Search for all records that start with 'test'
var options = {return: dg.Options.ELEMENT, all:true};
var result = dg.searchStartsWith('test', options);
console.log(result);
// Returns -
// [ { name: 'test1', value: 'one' },
//  { name: 'test2', value: 'two' },
//  { name: 'test3', value: 'three' } ]

(readonly)Type:number¶

Member for datagroup type enumeration. Can be useful for ` <#getType>`__

ILXDatagroup#getType

method. See F5 manual

BIG-IP System: iRules Concepts

for more information about datagroup types.

Type:¶

number

Properties:¶

Name	Type	Description
IP	number	1
STRING	number	2
INTEGER	number	3

Methods¶

forEach(index, element)→ {boolean}¶

Iterate though every element in the datagroup and run a callback for each of them, providing a read-only access to the element. If the callback function returns True, the loop will be interrupted.

Parameters:¶

Name	Type	Description
index	number	Index of the current record. Eg. useful to limit the number of runs.
element	object	Object containing both name and value of a record in datagroup. Eg. { name: <name>, value: <value>}

Returns:¶

Type	Description
boolean	If the function return value is true, the loop will be interrupted.

Example:¶

 // Iterate through the first 10 records in datagroup.
dg.forEach(function(index, element) {
   if (index >= 10) {
       return true;
   }
   console.log("name: " + element.name + " value: " + element.value);
});

getSize()→ {number}¶

Get the number of records in the datagroup.

Returns:¶

Type	Description
number	Number of records

getType()→ {number}¶

Get the type of the datagroup.

Returns:¶

Type	Description
number	Return number that represents these possible values enumerated in ` <#Type>`__ ILXDatagroup#Type member - 1 = Type IP 2 = Type STRING 3 = Type INTEGER

Type

Description

number

Return number that represents these possible values enumerated in ` <#Type>`__

ILXDatagroup#Type

member -

1 = Type IP
2 = Type STRING
3 = Type INTEGER

Example:¶

 // Get DG type number
console.log(dg.getType()); // Prints '2' if DG type string

// Get DG type string
var dgTypes = {};
Object.keys(dg.Type).forEach(function (key) {
  dgTypes[dg.Type[key]] = key; }
);
console.log(dgTypes[dg.getType()]); // Prints 'STRING' if DG type string

lookup(name)→ {string}¶

Lookup a value for given key (equivalent for matchEquals method returning a single value).

Parameters:¶

Name	Type	Description
name	string	Value to find

Returns:¶

Type	Description
string	Value of matched datagroup record

matchContains(name, [options])→ {string|object|array}¶

Search the datagroup for an element that contains part of

name

and return value based on

options

. Similar to

class match <item> contains <class>

in iRules TCL. See class documentation on Dev Central for more information.

Parameters:¶

Name Type Attributes Description

name

string

Value to find

options

object

Options to use for the search

Pro

perties

name:	prope

rties-2

+—+—+—+– -+—+ | 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 |

+===+===+===+== =+===+ | : | ` | < | n

r |

: | I | o | o | e |

| L | p | n
| t |
| X | t | e
| u |
| D | i |
| r |
| a | o |
| n |

r | t | n | | o |

e | a | a | | p |

t | g | l | | t |

u | r | > | | i |

r | o | | | o |

n | u | | | n |

| p |   |
| s |
| # |   |
| b |
| O |   |
| a |
| p |   |
| s |
| t |   |
| e |
| i |   |
| d |
| o |   |
| o |
| n |   |
| n |
| s |   |
| m |
|   |   |
| e |
| < |   |
| m |
| # |   |
| b |
| O |   |
| e |
| p |   |
| r |
| t |   |
| ` |
| i |   |
|   |
| o |   |
| < |
| n |   |
| # |
| s |   |
| O |
| > |   |
| p |
| ` |   |
| t |
| _ |   |
| i |
| _ |   |
| o |
| |   |
| n |
| | |   |
| s |
| n |   |
| > |
| u |   |
| ` |
| m |   |
| _ |
| b |   |
| _ |
| e |   |
|   |
| r |   |
| : |
|   |   |
| : |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
| I |
|   |   |
| L |
|   |   |
| X |
|   |   |
| D |
|   |   |
| a |
|   |   |
| t |
|   |   |
| a |
|   |   |
| g |
|   |   |
| r |
|   |   |
| o |
|   |   |
| u |
|   |   |
| p |
|   |   |
| # |
|   |   |
| O |
|   |   |
| p |
|   |   |
| t |
|   |   |
| i |
|   |   |
| o |
|   |   |
| n |
|   |   |
| s |

+—+—+—+– -+—+ | : | b | < | f

R |

: | o | o | a | e |

| o | p | l
| t |
| l | t | s
| u |
| e | i | e
| r |
| a | o |
| n |

a | n | n | | s |

l | | a | | a |

l | | l | | l |

|   | > |
| l |
|   |   |
| f |
|   |   |
| o |
|   |   |
| u |
|   |   |
| n |
|   |   |
| d |
|   |   |
| m |
|   |   |
| a |
|   |   |
| t |
|   |   |
| c |
|   |   |
| h |
|   |   |
| e |
|   |   |
| s |
|   |   |
| a |
|   |   |
| s |
|   |   |
| a |
|   |   |
| r |
|   |   |
| r |
|   |   |
| a |
|   |   |
| y |

+—+—+—+– -+—+ | : | b | < | f

C |

: | o | o | a | a |

| o | p | l
| s |
| l | t | s
| e |
| e | i | e
| i |
| a | o |
| n |

i | n | n | | s |

c | | a | | e |

a | | l | | n |

s | | > | | s |

e | | | | i |

|   |   |
| t |
|   |   |
| i |
|   |   |
| v |
|   |   |
| e |
|   |   |
| s |
|   |   |
| e |
|   |   |
| a |
|   |   |
| r |
|   |   |
| c |
|   |   |
| h |

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

Returns:¶

Type	Description
string \| object \| array	Results of method based on options choosen.

matchEndsWith(name, [options])→ {string|object|array}¶

Search the datagroup for an element that matches the end of

name

and return value based on

options

. Similar to

class match <item> ends_with <class>

in iRules TCL. See class documentation on Dev Central for more information.

Parameters:¶

Name Type Attributes Description

name

string

Value to find

options

object

Options to use for the search

Pro

perties

name:	prope

rties-3

+—+—+—+– -+—+ | 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 |

+===+===+===+== =+===+ | : | ` | < | n

r |

: | I | o | o | e |

| L | p | n
| t |
| X | t | e
| u |
| D | i |
| r |
| a | o |
| n |

r | t | n | | o |

e | a | a | | p |

t | g | l | | t |

u | r | > | | i |

r | o | | | o |

n | u | | | n |

| p |   |
| s |
| # |   |
| b |
| O |   |
| a |
| p |   |
| s |
| t |   |
| e |
| i |   |
| d |
| o |   |
| o |
| n |   |
| n |
| s |   |
| m |
|   |   |
| e |
| < |   |
| m |
| # |   |
| b |
| O |   |
| e |
| p |   |
| r |
| t |   |
| ` |
| i |   |
|   |
| o |   |
| < |
| n |   |
| # |
| s |   |
| O |
| > |   |
| p |
| ` |   |
| t |
| _ |   |
| i |
| _ |   |
| o |
| |   |
| n |
| | |   |
| s |
| n |   |
| > |
| u |   |
| ` |
| m |   |
| _ |
| b |   |
| _ |
| e |   |
|   |
| r |   |
| : |
|   |   |
| : |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
| I |
|   |   |
| L |
|   |   |
| X |
|   |   |
| D |
|   |   |
| a |
|   |   |
| t |
|   |   |
| a |
|   |   |
| g |
|   |   |
| r |
|   |   |
| o |
|   |   |
| u |
|   |   |
| p |
|   |   |
| # |
|   |   |
| O |
|   |   |
| p |
|   |   |
| t |
|   |   |
| i |
|   |   |
| o |
|   |   |
| n |
|   |   |
| s |

+—+—+—+– -+—+ | : | b | < | f

R |

: | o | o | a | e |

| o | p | l
| t |
| l | t | s
| u |
| e | i | e
| r |
| a | o |
| n |

a | n | n | | s |

l | | a | | a |

l | | l | | l |

|   | > |
| l |
|   |   |
| f |
|   |   |
| o |
|   |   |
| u |
|   |   |
| n |
|   |   |
| d |
|   |   |
| m |
|   |   |
| a |
|   |   |
| t |
|   |   |
| c |
|   |   |
| h |
|   |   |
| e |
|   |   |
| s |
|   |   |
| a |
|   |   |
| s |
|   |   |
| a |
|   |   |
| r |
|   |   |
| r |
|   |   |
| a |
|   |   |
| y |

+—+—+—+– -+—+ | : | b | < | f

C |

: | o | o | a | a |

| o | p | l
| s |
| l | t | s
| e |
| e | i | e
| i |
| a | o |
| n |

i | n | n | | s |

c | | a | | e |

a | | l | | n |

s | | > | | s |

e | | | | i |

|   |   |
| t |
|   |   |
| i |
|   |   |
| v |
|   |   |
| e |
|   |   |
| s |
|   |   |
| e |
|   |   |
| a |
|   |   |
| r |
|   |   |
| c |
|   |   |
| h |

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

Returns:¶

Type	Description
string \| object \| array	Results of method based on options choosen.

matchEquals(name, [options])→ {string|object|array}¶

Search the datagroup an element that is equal to

name

and return return value based on

options

. Similar to

class match <item> equals <class>

in iRules TCL. See class documentation on Dev Central for more information.

Parameters:¶

Name Type Attributes Description

name

string

Value to find

options

object

Options to use for the search

Pro

perties

name:	prope

rties-4

+—+—+—+– -+—+ | 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 |

+===+===+===+== =+===+ | : | ` | < | n

r |

: | I | o | o | e |

| L | p | n
| t |
| X | t | e
| u |
| D | i |
| r |
| a | o |
| n |

r | t | n | | o |

e | a | a | | p |

t | g | l | | t |

u | r | > | | i |

r | o | | | o |

n | u | | | n |

| p |   |
| s |
| # |   |
| b |
| O |   |
| a |
| p |   |
| s |
| t |   |
| e |
| i |   |
| d |
| o |   |
| o |
| n |   |
| n |
| s |   |
| m |
|   |   |
| e |
| < |   |
| m |
| # |   |
| b |
| O |   |
| e |
| p |   |
| r |
| t |   |
| ` |
| i |   |
|   |
| o |   |
| < |
| n |   |
| # |
| s |   |
| O |
| > |   |
| p |
| ` |   |
| t |
| _ |   |
| i |
| _ |   |
| o |
| |   |
| n |
| | |   |
| s |
| n |   |
| > |
| u |   |
| ` |
| m |   |
| _ |
| b |   |
| _ |
| e |   |
|   |
| r |   |
| : |
|   |   |
| : |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
| I |
|   |   |
| L |
|   |   |
| X |
|   |   |
| D |
|   |   |
| a |
|   |   |
| t |
|   |   |
| a |
|   |   |
| g |
|   |   |
| r |
|   |   |
| o |
|   |   |
| u |
|   |   |
| p |
|   |   |
| # |
|   |   |
| O |
|   |   |
| p |
|   |   |
| t |
|   |   |
| i |
|   |   |
| o |
|   |   |
| n |
|   |   |
| s |

+—+—+—+– -+—+ | : | b | < | f

R |

: | o | o | a | e |

| o | p | l
| t |
| l | t | s
| u |
| e | i | e
| r |
| a | o |
| n |

a | n | n | | s |

l | | a | | a |

l | | l | | l |

|   | > |
| l |
|   |   |
| f |
|   |   |
| o |
|   |   |
| u |
|   |   |
| n |
|   |   |
| d |
|   |   |
| m |
|   |   |
| a |
|   |   |
| t |
|   |   |
| c |
|   |   |
| h |
|   |   |
| e |
|   |   |
| s |
|   |   |
| a |
|   |   |
| s |
|   |   |
| a |
|   |   |
| r |
|   |   |
| r |
|   |   |
| a |
|   |   |
| y |

+—+—+—+– -+—+ | : | b | < | f

C |

: | o | o | a | a |

| o | p | l
| s |
| l | t | s
| e |
| e | i | e
| i |
| a | o |
| n |

i | n | n | | s |

c | | a | | e |

a | | l | | n |

s | | > | | s |

e | | | | i |

|   |   |
| t |
|   |   |
| i |
|   |   |
| v |
|   |   |
| e |
|   |   |
| s |
|   |   |
| e |
|   |   |
| a |
|   |   |
| r |
|   |   |
| c |
|   |   |
| h |

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

Returns:¶

Type	Description
string \| object \| array	Results of method based on options choose

matchStartsWith(name, [options])→ {string|object|array}¶

Search the datagroup for an element that matches the start of

name

and return value based on

options

. Similar to

class match <item> starts_with <class>

in iRules TCL. See class documentation on Dev Central for more information.

Parameters:¶

Name Type Attributes Description

name

string

Value to find

options

object

Options to use for the search

Pro

perties

name:	prope

rties-5

+—+—+—+– -+—+ | 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 |

+===+===+===+== =+===+ | : | ` | < | n

r |

: | I | o | o | e |

| L | p | n
| t |
| X | t | e
| u |
| D | i |
| r |
| a | o |
| n |

r | t | n | | o |

e | a | a | | p |

t | g | l | | t |

u | r | > | | i |

r | o | | | o |

n | u | | | n |

| p |   |
| s |
| # |   |
| b |
| O |   |
| a |
| p |   |
| s |
| t |   |
| e |
| i |   |
| d |
| o |   |
| o |
| n |   |
| n |
| s |   |
| m |
|   |   |
| e |
| < |   |
| m |
| # |   |
| b |
| O |   |
| e |
| p |   |
| r |
| t |   |
| ` |
| i |   |
|   |
| o |   |
| < |
| n |   |
| # |
| s |   |
| O |
| > |   |
| p |
| ` |   |
| t |
| _ |   |
| i |
| _ |   |
| o |
| |   |
| n |
| | |   |
| s |
| n |   |
| > |
| u |   |
| ` |
| m |   |
| _ |
| b |   |
| _ |
| e |   |
|   |
| r |   |
| : |
|   |   |
| : |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
| I |
|   |   |
| L |
|   |   |
| X |
|   |   |
| D |
|   |   |
| a |
|   |   |
| t |
|   |   |
| a |
|   |   |
| g |
|   |   |
| r |
|   |   |
| o |
|   |   |
| u |
|   |   |
| p |
|   |   |
| # |
|   |   |
| O |
|   |   |
| p |
|   |   |
| t |
|   |   |
| i |
|   |   |
| o |
|   |   |
| n |
|   |   |
| s |

+—+—+—+– -+—+ | : | b | < | f

R |

: | o | o | a | e |

| o | p | l
| t |
| l | t | s
| u |
| e | i | e
| r |
| a | o |
| n |

a | n | n | | s |

l | | a | | a |

l | | l | | l |

|   | > |
| l |
|   |   |
| f |
|   |   |
| o |
|   |   |
| u |
|   |   |
| n |
|   |   |
| d |
|   |   |
| m |
|   |   |
| a |
|   |   |
| t |
|   |   |
| c |
|   |   |
| h |
|   |   |
| e |
|   |   |
| s |
|   |   |
| a |
|   |   |
| s |
|   |   |
| a |
|   |   |
| r |
|   |   |
| r |
|   |   |
| a |
|   |   |
| y |

+—+—+—+– -+—+ | : | b | < | f

C |

: | o | o | a | a |

| o | p | l
| s |
| l | t | s
| e |
| e | i | e
| i |
| a | o |
| n |

i | n | n | | s |

c | | a | | e |

a | | l | | n |

s | | > | | s |

e | | | | i |

|   |   |
| t |
|   |   |
| i |
|   |   |
| v |
|   |   |
| e |
|   |   |
| s |
|   |   |
| e |
|   |   |
| a |
|   |   |
| r |
|   |   |
| c |
|   |   |
| h |

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

Returns:¶

Type	Description
string \| object \| array	Results of method based on options choose

searchContains(name, [options])→ {string|object|array}¶

Search the datagroup for an element that contains

name

and return value based on

options

. Similar to

class search <class> contains <item>

in iRules TCL. See class documentation on Dev Central for more information.

Parameters:¶

Name Type Attributes Description

name

string

Value to find

options

object

Options to use for the search

Pro

perties

name:	prope

rties-6

+—+—+—+– -+—+ | 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 |

+===+===+===+== =+===+ | : | ` | < | n

r |

: | I | o | o | e |

| L | p | n
| t |
| X | t | e
| u |
| D | i |
| r |
| a | o |
| n |

r | t | n | | o |

e | a | a | | p |

t | g | l | | t |

u | r | > | | i |

r | o | | | o |

n | u | | | n |

| p |   |
| s |
| # |   |
| b |
| O |   |
| a |
| p |   |
| s |
| t |   |
| e |
| i |   |
| d |
| o |   |
| o |
| n |   |
| n |
| s |   |
| m |
|   |   |
| e |
| < |   |
| m |
| # |   |
| b |
| O |   |
| e |
| p |   |
| r |
| t |   |
| ` |
| i |   |
|   |
| o |   |
| < |
| n |   |
| # |
| s |   |
| O |
| > |   |
| p |
| ` |   |
| t |
| _ |   |
| i |
| _ |   |
| o |
| |   |
| n |
| | |   |
| s |
| n |   |
| > |
| u |   |
| ` |
| m |   |
| _ |
| b |   |
| _ |
| e |   |
|   |
| r |   |
| : |
|   |   |
| : |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
| I |
|   |   |
| L |
|   |   |
| X |
|   |   |
| D |
|   |   |
| a |
|   |   |
| t |
|   |   |
| a |
|   |   |
| g |
|   |   |
| r |
|   |   |
| o |
|   |   |
| u |
|   |   |
| p |
|   |   |
| # |
|   |   |
| O |
|   |   |
| p |
|   |   |
| t |
|   |   |
| i |
|   |   |
| o |
|   |   |
| n |
|   |   |
| s |

+—+—+—+– -+—+ | : | b | < | f

R |

: | o | o | a | e |

| o | p | l
| t |
| l | t | s
| u |
| e | i | e
| r |
| a | o |
| n |

a | n | n | | s |

l | | a | | a |

l | | l | | l |

|   | > |
| l |
|   |   |
| f |
|   |   |
| o |
|   |   |
| u |
|   |   |
| n |
|   |   |
| d |
|   |   |
| m |
|   |   |
| a |
|   |   |
| t |
|   |   |
| c |
|   |   |
| h |
|   |   |
| e |
|   |   |
| s |
|   |   |
| a |
|   |   |
| s |
|   |   |
| a |
|   |   |
| r |
|   |   |
| r |
|   |   |
| a |
|   |   |
| y |

+—+—+—+– -+—+ | : | b | < | f

C |

: | o | o | a | a |

| o | p | l
| s |
| l | t | s
| e |
| e | i | e
| i |
| a | o |
| n |

i | n | n | | s |

c | | a | | e |

a | | l | | n |

s | | > | | s |

e | | | | i |

|   |   |
| t |
|   |   |
| i |
|   |   |
| v |
|   |   |
| e |
|   |   |
| s |
|   |   |
| e |
|   |   |
| a |
|   |   |
| r |
|   |   |
| c |
|   |   |
| h |

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

Returns:¶

Type	Description
string \| object \| array	Results of method based on options choosen.

searchEndsWith(name, [options])→ {string|object|array}¶

Search the datagroup for an element that ends with

name

and return value based on

options

. Similar to

class search <class> ends_with <item>

in iRules TCL. See class documentation on Dev Central for more information.

Parameters:¶

Name Type Attributes Description

name

string

Value to find

options

object

Options to use for the search

Pro

perties

name:	prope

rties-7

+—+—+—+– -+—+ | 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 |

+===+===+===+== =+===+ | : | ` | < | n

r |

: | I | o | o | e |

| L | p | n
| t |
| X | t | e
| u |
| D | i |
| r |
| a | o |
| n |

r | t | n | | o |

e | a | a | | p |

t | g | l | | t |

u | r | > | | i |

r | o | | | o |

n | u | | | n |

| p |   |
| s |
| # |   |
| b |
| O |   |
| a |
| p |   |
| s |
| t |   |
| e |
| i |   |
| d |
| o |   |
| o |
| n |   |
| n |
| s |   |
| m |
|   |   |
| e |
| < |   |
| m |
| # |   |
| b |
| O |   |
| e |
| p |   |
| r |
| t |   |
| ` |
| i |   |
|   |
| o |   |
| < |
| n |   |
| # |
| s |   |
| O |
| > |   |
| p |
| ` |   |
| t |
| _ |   |
| i |
| _ |   |
| o |
| |   |
| n |
| | |   |
| s |
| n |   |
| > |
| u |   |
| ` |
| m |   |
| _ |
| b |   |
| _ |
| e |   |
|   |
| r |   |
| : |
|   |   |
| : |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
| I |
|   |   |
| L |
|   |   |
| X |
|   |   |
| D |
|   |   |
| a |
|   |   |
| t |
|   |   |
| a |
|   |   |
| g |
|   |   |
| r |
|   |   |
| o |
|   |   |
| u |
|   |   |
| p |
|   |   |
| # |
|   |   |
| O |
|   |   |
| p |
|   |   |
| t |
|   |   |
| i |
|   |   |
| o |
|   |   |
| n |
|   |   |
| s |

+—+—+—+– -+—+ | : | b | < | f

R |

: | o | o | a | e |

| o | p | l
| t |
| l | t | s
| u |
| e | i | e
| r |
| a | o |
| n |

a | n | n | | s |

l | | a | | a |

l | | l | | l |

|   | > |
| l |
|   |   |
| f |
|   |   |
| o |
|   |   |
| u |
|   |   |
| n |
|   |   |
| d |
|   |   |
| m |
|   |   |
| a |
|   |   |
| t |
|   |   |
| c |
|   |   |
| h |
|   |   |
| e |
|   |   |
| s |
|   |   |
| a |
|   |   |
| s |
|   |   |
| a |
|   |   |
| r |
|   |   |
| r |
|   |   |
| a |
|   |   |
| y |

+—+—+—+– -+—+ | : | b | < | f

C |

: | o | o | a | a |

| o | p | l
| s |
| l | t | s
| e |
| e | i | e
| i |
| a | o |
| n |

i | n | n | | s |

c | | a | | e |

a | | l | | n |

s | | > | | s |

e | | | | i |

|   |   |
| t |
|   |   |
| i |
|   |   |
| v |
|   |   |
| e |
|   |   |
| s |
|   |   |
| e |
|   |   |
| a |
|   |   |
| r |
|   |   |
| c |
|   |   |
| h |

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

Returns:¶

Type	Description
string \| object \| array	Results of method based on options choosen.

searchEquals(name, [options])→ {string|object|array}¶

Search the datagroup for an element that equals name and return value based on

options

. Similar to

class search <class> equals <item>

in iRules TCL. See class documentation on Dev Central for more information.

Note: searchEquals and matchEquals are completely the same.

Parameters:¶

Name Type Attributes Description

name

string

Value to find

options

object

Options to use for the search

Pro

perties

name:	prope

rties-8

+—+—+—+– -+—+ | 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 |

+===+===+===+== =+===+ | : | ` | < | n

r |

: | I | o | o | e |

| L | p | n
| t |
| X | t | e
| u |
| D | i |
| r |
| a | o |
| n |

r | t | n | | o |

e | a | a | | p |

t | g | l | | t |

u | r | > | | i |

r | o | | | o |

n | u | | | n |

| p |   |
| s |
| # |   |
| b |
| O |   |
| a |
| p |   |
| s |
| t |   |
| e |
| i |   |
| d |
| o |   |
| o |
| n |   |
| n |
| s |   |
| m |
|   |   |
| e |
| < |   |
| m |
| # |   |
| b |
| O |   |
| e |
| p |   |
| r |
| t |   |
| ` |
| i |   |
|   |
| o |   |
| < |
| n |   |
| # |
| s |   |
| O |
| > |   |
| p |
| ` |   |
| t |
| _ |   |
| i |
| _ |   |
| o |
| |   |
| n |
| | |   |
| s |
| n |   |
| > |
| u |   |
| ` |
| m |   |
| _ |
| b |   |
| _ |
| e |   |
|   |
| r |   |
| : |
|   |   |
| : |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
| I |
|   |   |
| L |
|   |   |
| X |
|   |   |
| D |
|   |   |
| a |
|   |   |
| t |
|   |   |
| a |
|   |   |
| g |
|   |   |
| r |
|   |   |
| o |
|   |   |
| u |
|   |   |
| p |
|   |   |
| # |
|   |   |
| O |
|   |   |
| p |
|   |   |
| t |
|   |   |
| i |
|   |   |
| o |
|   |   |
| n |
|   |   |
| s |

+—+—+—+– -+—+ | : | b | < | f

R |

: | o | o | a | e |

| o | p | l
| t |
| l | t | s
| u |
| e | i | e
| r |
| a | o |
| n |

a | n | n | | s |

l | | a | | a |

l | | l | | l |

|   | > |
| l |
|   |   |
| f |
|   |   |
| o |
|   |   |
| u |
|   |   |
| n |
|   |   |
| d |
|   |   |
| m |
|   |   |
| a |
|   |   |
| t |
|   |   |
| c |
|   |   |
| h |
|   |   |
| e |
|   |   |
| s |
|   |   |
| a |
|   |   |
| s |
|   |   |
| a |
|   |   |
| r |
|   |   |
| r |
|   |   |
| a |
|   |   |
| y |

+—+—+—+– -+—+ | : | b | < | f

C |

: | o | o | a | a |

| o | p | l
| s |
| l | t | s
| e |
| e | i | e
| i |
| a | o |
| n |

i | n | n | | s |

c | | a | | e |

a | | l | | n |

s | | > | | s |

e | | | | i |

|   |   |
| t |
|   |   |
| i |
|   |   |
| v |
|   |   |
| e |
|   |   |
| s |
|   |   |
| e |
|   |   |
| a |
|   |   |
| r |
|   |   |
| c |
|   |   |
| h |

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

Returns:¶

Type	Description
string \| object \| array	Results of method based on options choosen.

searchStartsWith(name, [options])→ {string|object|array}¶

Search the datagroup for an element that starts with

name

and return value based on

options

. Similar to

class search <class> starts_with <item>

in iRules TCL. See class documentation on Dev Central for more information.

Parameters:¶

Name Type Attributes Description

name

string

Value to find

options

object

Options to use for the search

Pro

perties

name:	prope

rties-9

+—+—+—+– -+—+ | 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 |

+===+===+===+== =+===+ | : | ` | < | n

r |

: | I | o | o | e |

| L | p | n
| t |
| X | t | e
| u |
| D | i |
| r |
| a | o |
| n |

r | t | n | | o |

e | a | a | | p |

t | g | l | | t |

u | r | > | | i |

r | o | | | o |

n | u | | | n |

| p |   |
| s |
| # |   |
| b |
| O |   |
| a |
| p |   |
| s |
| t |   |
| e |
| i |   |
| d |
| o |   |
| o |
| n |   |
| n |
| s |   |
| m |
|   |   |
| e |
| < |   |
| m |
| # |   |
| b |
| O |   |
| e |
| p |   |
| r |
| t |   |
| ` |
| i |   |
|   |
| o |   |
| < |
| n |   |
| # |
| s |   |
| O |
| > |   |
| p |
| ` |   |
| t |
| _ |   |
| i |
| _ |   |
| o |
| |   |
| n |
| | |   |
| s |
| n |   |
| > |
| u |   |
| ` |
| m |   |
| _ |
| b |   |
| _ |
| e |   |
|   |
| r |   |
| : |
|   |   |
| : |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
|   |
|   |   |
| I |
|   |   |
| L |
|   |   |
| X |
|   |   |
| D |
|   |   |
| a |
|   |   |
| t |
|   |   |
| a |
|   |   |
| g |
|   |   |
| r |
|   |   |
| o |
|   |   |
| u |
|   |   |
| p |
|   |   |
| # |
|   |   |
| O |
|   |   |
| p |
|   |   |
| t |
|   |   |
| i |
|   |   |
| o |
|   |   |
| n |
|   |   |
| s |

+—+—+—+– -+—+ | : | b | < | f

R |

: | o | o | a | e |

| o | p | l
| t |
| l | t | s
| u |
| e | i | e
| r |
| a | o |
| n |

a | n | n | | s |

l | | a | | a |

l | | l | | l |

|   | > |
| l |
|   |   |
| f |
|   |   |
| o |
|   |   |
| u |
|   |   |
| n |
|   |   |
| d |
|   |   |
| m |
|   |   |
| a |
|   |   |
| t |
|   |   |
| c |
|   |   |
| h |
|   |   |
| e |
|   |   |
| s |
|   |   |
| a |
|   |   |
| s |
|   |   |
| a |
|   |   |
| r |
|   |   |
| r |
|   |   |
| a |
|   |   |
| y |

+—+—+—+– -+—+ | : | b | < | f

C |

: | o | o | a | a |

| o | p | l
| s |
| l | t | s
| e |
| e | i | e
| i |
| a | o |
| n |

i | n | n | | s |

c | | a | | e |

a | | l | | n |

s | | > | | s |

e | | | | i |

|   |   |
| t |
|   |   |
| i |
|   |   |
| v |
|   |   |
| e |
|   |   |
| s |
|   |   |
| e |
|   |   |
| a |
|   |   |
| r |
|   |   |
| c |
|   |   |
| h |

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

Returns:¶

Type	Description
string \| object \| array	Results of method based on options choosen.

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.

Previous Next