Security::FirewallAddressList¶
Introduced : BIG-IP_v11.3.0
The FirewallAddressList interface enables you to create and modify IP
address lists on which to perform firewall security actions. Note that
the addresses in all methods are type Common::NetAddress, a type which
allows one to specify a prefix length after the address, e.g.,
“10.1.1.0/24”.
Methods¶
| Method | Description | Introduced |
| add_address | This method has been deprecated. Please use add_address_range instead. When using this method, the system will create a corresponding one-element address range where begin is equal to end. Adds a set of IP addresses to the specified firewall IP address lists. | BIG-IP_v11.3.0 |
| add_address_range | Adds a list of address ranges for the specified firewall IP address lists. | BIG-IP_v11.5.0 |
| add_geo | Adds a set of geo locations to the specified firewall IP address lists. | BIG-IP_v11.5.0 |
| add_nested_address_list | Adds a list of nested address lists for the specified firewall IP address lists. | BIG-IP_v11.5.0 |
| create | Creates a firewall IP address list. | BIG-IP_v11.3.0 |
| create_with_address_range | Creates a firewall IP address list with address range. Users can specify an IP address range as the source or destination IP addresses in an AFM rule. For example, an IPv4 address range 10.10.10.1-10.10.10.245 will match all 245 addresses 10.10.10.1, 10.10.10.2, 10.10.10.3, … 10.10.10.244, 10.10.10.245. | BIG-IP_v11.5.0 |
| create_with_geo | Creates a firewall IP address list with geo location. The geo location is a combination of country code and state name. The country code is two characters long. The state name is the full name of a state that belongs to the country represented by country code. By defining the geo location, the user can use the geo location entry to apply it to rules in the access control lists. | BIG-IP_v11.5.0 |
| create_with_nested_address_list | Creates a firewall IP address list with nested address list. Users can enter an address list as one of the list entries of another address list. For example, users can have an address list alist-1 that contains the address 10.10.10.1. Users can have another address list alist-2 that contains address 10.10.10.2 and alist-1 as the child list. If the address list alist-2 is used in an AFM rule as source or destination address list, the addresses inside the child lists will be fully expanded so that the addresses AFM rule will match for alist-2 are 10.10.10.1 and 10.10.10.2. | BIG-IP_v11.5.0 |
| delete_address_list | Deletes a set of firewall IP address lists. | BIG-IP_v11.3.0 |
| delete_all_address_lists | Deletes all firewall IP address lists on this device. | BIG-IP_v11.3.0 |
| get_address | This method has been deprecated. Please use get_address_range instead. Firewall addresses are now supplied and stored in the form of an address range. Single addresses are converted to a corresponding one-element range where begin is equal to end; for each range, this method returns the start of the address range. Gets the entries of the specified firewall IP address lists. | BIG-IP_v11.3.0 |
| get_address_description | This method has been deprecated. Please use get_address_range_description instead. Gets the descriptions for a set of firewall IP address ranges. | BIG-IP_v11.3.0 |
| get_address_range | Gets address ranges for the specified firewall IP address lists. Users can specify an IP address range as the source or destination IP addresses in an AFM rule. For example, an IPv4 address range 10.10.10.1-10.10.10.245 will match all 245 addresses 10.10.10.1, 10.10.10.2, 10.10.10.3, … 10.10.10.244, 10.10.10.245. | BIG-IP_v11.5.0 |
| get_address_range_description | Gets the descriptions for the specified address ranges. | BIG-IP_v11.5.0 |
| get_description | Gets the descriptions for a set of firewall IP address lists. | BIG-IP_v11.3.0 |
| get_geo | Gets the geo location entries of the specified firewall IP address lists. The geo location is a combination of country code and state name. The country code is two characters long. The state name is the full name of a state that belongs to the country represented by country code. By defining the geo location, the user can use the geo location entry to apply it to rules in the access control lists. | BIG-IP_v11.5.0 |
| get_geo_description | Gets the descriptions for a set of firewall IP address list entries. | BIG-IP_v11.5.0 |
| get_list | Gets the list of firewall IP address lists on this device. | BIG-IP_v11.3.0 |
| get_nested_address_list | Gets nested address lists for the specified firewall IP address lists. Users can enter an address list as one of the list entries of another address list. For example, users can have an address list alist-1 that contains the address 10.10.10.1. Users can have another address list alist-2 that contains address 10.10.10.2 and alist-1 as the child list. If the address list alist-2 is used in an AFM rule as source or destination address list, the addresses inside the child lists will be fully expanded so that the addresses AFM rule will match for alist-2 are 10.10.10.1 and 10.10.10.2. | BIG-IP_v11.5.0 |
| get_nested_address_list_description | Gets the descriptions for the specified nested address lists. | BIG-IP_v11.5.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.3.0 |
| remove_address | This method has been deprecated. Please use remove_address_range instead. When using this method, the system will create a corresponding one-element address range where begin is equal to end. Removes a set of entries from the specified firewall IP address lists. | BIG-IP_v11.3.0 |
| remove_address_range | Removes a list of address ranges from the specified firewall IP address lists. | BIG-IP_v11.5.0 |
| remove_all_address_ranges | Removes all address ranges from the specified firewall IP address lists. | BIG-IP_v11.5.0 |
| remove_all_addresses | This method has been deprecated. Please use remove_all_address_ranges instead. Removes all entries from the specified firewall IP address lists. | BIG-IP_v11.3.0 |
| remove_all_geos | Removes all geo location entries from the specified firewall IP address lists. | BIG-IP_v11.5.0 |
| remove_all_nested_address_lists | Removes all nested address lists from the specified firewall IP address lists. | BIG-IP_v11.5.0 |
| remove_geo | Removes a set of geo location entries from the specified firewall IP address lists. | BIG-IP_v11.5.0 |
| remove_nested_address_list | Removes a list of nested address lists from the specified firewall IP address lists. | BIG-IP_v11.5.0 |
| set_address_description | This method has been deprecated. Please use set_address_range_description instead. Sets the description for a set of firewall IP address ranges. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_address_range_description | Sets the descriptions for the specified address ranges. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.5.0 |
| set_description | Sets the description for a set of firewall IP address lists. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_geo_description | Sets the description for a set of firewall geo location entries. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.5.0 |
| set_nested_address_list_description | Sets the descriptions for the specified nested address lists. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.5.0 |
See Also¶
iControl ::
Warning
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.