ltm data-group external¶

ltm data-group external(1) BIG-IP TMSH Manual ltm data-group external(1)

NAME
external - Configures an external class.

MODULE
ltm data-group

SYNTAX
Configure the external data-group within the ltm data-group module using the syntax shown in the following sections.

CREATE/MODIFY
create external [name]
modify external [name]
options:
app-service [[string] | none]
description [string]
external-file-name [ [file name] | none]
separator [string]
source-path [URL]
type [integer | ip | string ]

edit external [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties

DISPLAY
list external
list external [ [ [name] | [glob] | [regex] ] ... ]
show [name] external-records
show running-config external
show running-config external [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition

DELETE
delete external [name]

DESCRIPTION
Data groups are lists of data that you define and use with iRules(r) operators. External data group records are stored in
external files that you manage through the sys file data-group component. Note that external data groups can be very large,
which is one reason why the groups are saved to external files. For example, a phone company may store a list of thousands
of phone numbers in an external data group.

You should consider using an internal data group when the number of records is expected to be small.

An external data group acquires its type from the associated data-group file, which can be a list of IP addresses, strings,
or integers.

External data groups are lists that specify:

• A data-group file where records are stored

• A description of the class

There are two ways to configure the external data-group object:

• Create external data-group object, and then specify the source-path and type of the external-file. In one step the
external-file will be created within the sys file data-group module and external data-group within the ltm data-group
module.

• Create an external-file within the sys file data-group module, and then create external data-group within the ltm
data-group module. See help sys file data-group for information on creating the data-group file.

EXAMPLES
create external ext-dg1 external-file-name string.dat description "created for rule xyz"
Creates an external data group named ext-dg1, with the given description. The records for the data group are loaded
from the data-group file string.dat previously created in the sys file data-group component.

create external ext-dg1 description "created for rule xyz" source-path http:/file-server/data-groups/ip.class type ip
Downloads the data-group file from the given URL into file-store and creates a data-group file named ext-dg1 within
the sys file data-group module. Creates an external data group named ext-dg1, with the given description. The records
for the data group are loaded from the data-group file ext-dg1.

create external ext-dg2 source-path file:/shared/save/Test.dat type string
Creates a data-group file named ext-dg2 within the sys file data-group module. Creates an external data group named
ext-dg2. The records for the data group are loaded from the data-group file ext-dg2.

modify external ext-dg2 description "created for rule abc" source-path file:/shared/save/Test2.dat
Downloads the file from the given URL into file-store and updates the source-path of data-group file referenced by
external data group ext-dg2. Modifies the description of external data group ext-dg2.

delete external ext-dg1
Deletes the external data group named ext-dg1. Note: the data-group file referenced by ext-dg1 is not deleted at this
time. If needed, it should be deleted under sys file data-group component.

show external ext-dg1 external-records Shows a sorted list of external data group records. Note: We recommend against
displaying data-groups of over two million records due to control-plane resource constraints.

OPTIONS
app-service
Specifies the name of the application service to which the data group belongs. The default value is none. Note: If the
strict-updates option is enabled on the application service that owns the object, you cannot modify or delete the data
group. Only the application service can modify or delete the data group.

description
User defined description.

external-file-name
Specifies the data-group file where the records are stored.

Note: Only source-path or external-file-name may be specified for external data-group configuration item.

regex
Displays the items that match the regular expression. The regular expression must be preceded by an at sign (@[regular
expression]) to indicate that the identifier is a regular expression. See help regex for a description of regular
expression syntax.

separator
Specifies a separator to use when defining the data group. The default value is :=.

source-path [URL]
This optional attribute takes a URL.

Note: Only source-path or external-file-name may be specified for external data-group configuration item, for example:

source-path http://file-server/data-groups/AUL_1.cls

source-path https://file-server/data-groups/CNN.x

source-path ftp://username:password@server/data-groups/latest.class

source-path file:/shared/save/Test.dat

type Specifies the kind of data in the group. This option is acquired from the data group file. If the external data group
is created with external-file that was previously created within the sys file data-group module, then type option
cannot be modified. If the external data group is created with source-path option, then type should be specified. The
value for type could be integer or ip or string.

SEE ALSO
create, delete, edit, glob, list, modify, regex, tmsh

COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
use, without the express written permission of F5 Networks, Inc.

BIG-IP 2016-08-04 ltm data-group external(1)