Security::DoSWhitelist¶
Introduced : BIG-IP_v11.5.0
The DoS Whitelist interface enables you to manipulate a DoS whitelist.
While blacklists are used to block traffic, you can use whitelists to
allow traffic based on specific IP addresses. Whitelists can be
assigned to global, route domain, and virtual server contexts. There
is only one DoS Whitelist for the entire system, called
“dos-network-whitelist”. Please supply this key to all methods
requiring the “whitelists” argument.
Methods¶
| Method | Description | Introduced |
| add_entry | Adds a list of entries for the specified DoS whitelists. | BIG-IP_v11.5.0 |
| get_description | Gets the descriptions for the specified DoS whitelists. | BIG-IP_v12.0.0 |
| get_entry | Gets entries for the specified DoS whitelists. You can add or remove whitelist entries. Each entry specifies an IP address, and can optionally specify other information. | BIG-IP_v11.5.0 |
| get_entry_description | Gets the descriptions for the specified DoS whitelist entries. | BIG-IP_v12.0.0 |
| get_entry_destination_address | Gets the destination addresses for the specified entries. | BIG-IP_v11.5.0 |
| get_entry_destination_port | Gets the destination ports for the specified entries. | BIG-IP_v11.5.0 |
| get_entry_protocol_type | Gets the protocol types for the specified entries. | BIG-IP_v11.5.0 |
| get_entry_source_address | Gets the source addresses for the specified entries. | BIG-IP_v11.5.0 |
| get_entry_source_vlan | Gets the source VLANs for the specified entries. | BIG-IP_v11.5.0 |
| get_list | Gets a list of all DoS whitelists. You can use whitelists to allow traffic based on specific IP addresses. | BIG-IP_v11.5.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.5.0 |
| remove_all_entries | Removes all entries from the specified DoS whitelists. | BIG-IP_v11.5.0 |
| remove_entry | Removes a list of entries from the specified DoS whitelists. | BIG-IP_v11.5.0 |
| set_description | Sets the descriptions for the specified DoS whitelists. This is an arbitrary field which can be used for any purpose. | BIG-IP_v12.0.0 |
| set_entry_description | Sets the descriptions for the specified DoS whitelist entries. This is an arbitrary field which can be used for any purpose. | BIG-IP_v12.0.0 |
| set_entry_destination_address | Sets the destination addresses for the specified entries. Specifies the destination IP addresses for which traffic is allowed. | BIG-IP_v11.5.0 |
| set_entry_destination_port | Sets the destination ports for the specified entries. Specifies the destination ports for which traffic is allowed. | BIG-IP_v11.5.0 |
| set_entry_protocol_type | Sets the protocol types for the specified entries. Specifies the protocol types for which traffic is allowed. | BIG-IP_v11.5.0 |
| set_entry_source_address | Sets the source addresses for the specified entries. Specifies the source IP addresses for which traffic is allowed. | BIG-IP_v11.5.0 |
| set_entry_source_vlan | Sets the source VLANs for the specified entries. Specifies the source VLANs (Virtual Local Area Network) for which traffic is allowed. | BIG-IP_v11.5.0 |
Enumerations¶
| Enumeration | Description |
| ProtocolType | A list of protocol types for the whitelist which allow traffic. |
Aliases¶
| Alias | Type | Description |
| ProtocolTypeSequence | ProtocolType [] | A sequence of protocol types. |
| ProtocolTypeSequenceSequence | ProtocolType [] [] | A sequence of sequence of protocol types. |
| ProtocolTypeSequenceSequenceSequence | ProtocolType [] [] [] | A sequence of sequence of sequence of protocol types. |
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.