Introduced : BIG-IP_v9.2.0
The Region interface enables you to work with user-defined region definitions.


Method Description Introduced
add_region_item Adds the specified region items to the specified region definitions. BIG-IP_v9.2.0
create Creates the specified region definitions with the specified region items. BIG-IP_v9.2.0
delete_all_region_definitions Deletes all region definitions. BIG-IP_v9.2.0
delete_region_definition Deletes the specified region definitions. BIG-IP_v9.2.0
get_description Gets the description of the given region definitions. BIG-IP_v11.0.0
get_list Gets a list of of region definitions. BIG-IP_v9.2.0
get_region_item Gets the list of region items that define the specified regions. BIG-IP_v9.2.0
get_version Gets the version information for this interface. BIG-IP_v9.2.0
remove_all_region_items Removes any and all region items in the specified regions. BIG-IP_v9.2.0
remove_region_item Removes the specified region items from the specified region definitions. BIG-IP_v9.2.0
set_description Sets the description of the given region definitions. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0





A struct that describes a region definition.


A struct that describes a region item.


Enumeration Description


Exception Description


Constant Type Value Description


Alias Type Description
RegionDefinitionSequence RegionDefinition [] A sequence of region definitions.
RegionItemSequence RegionItem [] A sequence of region items.
RegionItemSequenceSequence RegionItem [] [] An alias for a sequence of region items.

See Also


The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code

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.