LocalLB::Rule

Introduced : BIG-IP_v9.0
The Rule interface enables you to manipulate a local load balancer&aposs rules. For example, use the Rule interface to get a list of all rules, create rules, delete rules, modify rules, and query rules.

Methods

Method Description Introduced
add_checksum Computes and adds a checksum to each specified rule. BIG-IP_v11.1.0
add_metadata Adds the metadata for the specified rules. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
add_signature Computes and adds a signature to each specified rule. The signature is used during rule validation to assure that the rule definition has not been modified. BIG-IP_v11.1.0
create Creates the specified rules. BIG-IP_v9.0
delete_all_rules Deletes all user-defined rules. BIG-IP_v9.0
delete_rule Deletes the specified rules. An exception will be raised when attempting to delete a default system rule. BIG-IP_v9.0
get_all_statistics Gets the statistics for all the rules. BIG-IP_v9.0
get_description Gets the descriptions for the specified rules. BIG-IP_v11.0.0
get_ignore_verification Gets the state of ignoring the signature or checksum. BIG-IP_v11.1.0
get_list Gets a list of all rules. BIG-IP_v9.0
get_metadata Gets the user metadata for the specified rules. User metadata, also metadata for short, is mainly a name/value pair that is associated with a metadata capable config (MCC) object. Some exmaples of MCC objects are ltm pool and virtual server. The combination of the MCC object name and the metadata name uniguely identify an instance of the metadata. One MCC object may have multiple instances of metadata associated with it. In addition to name/value pair, metadata also has a persistence attribute. See Common::MetadataPersistence for its definition. BIG-IP_v11.2.0
get_metadata_description Gets the metadata descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
get_metadata_persistence Gets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
get_metadata_value Gets the metadata values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
get_statistics Gets the statistics for the specified rules. BIG-IP_v9.0
get_verification_status This method has been deprecated, due to the movement of enumeration VerificationStatus and VerificationStatusSequence from LocalLB:Rule to Common. Please use get_verification_status_v2. Gets the verification status for the specified rules. BIG-IP_v11.1.0
get_verification_status_v2 Gets the verification status for the specified rules. BIG-IP_v11.4.0
get_version Gets the version information for this interface. BIG-IP_v9.0
modify_rule Modifies the specified rules. BIG-IP_v9.0
query_all_rules Queries all rules. BIG-IP_v9.0
query_rule Queries the specified rules. BIG-IP_v9.0
remove_all_metadata Removes all the metadata instances for the specified rules. BIG-IP_v11.2.0
remove_metadata Removes the metadata for the specified rules and names. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
reset_statistics Resets the statistics for the specified rules. BIG-IP_v9.0
set_description Sets the description for a set of iRules. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0
set_ignore_verification Sets the state to ignore the signature or checksum. The checksum is used during rule validation to assure that the rule definition has not been modified. BIG-IP_v11.1.0
set_metadata_description Sets the descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
set_metadata_persistence Sets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
set_metadata_value Sets the values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0

Structures

Structure

Description

RuleDefinition

A struct that describes the rule and its definition.

RuleStatisticEntry

A struct that describes statistics for a particular rule.

RuleStatistics

A struct that describes pool statistics and timestamp.


Enumerations

Enumeration Description
VerificationStatus An enumeration of rule verification status.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
RuleDefinitionSequence RuleDefinition [] A sequence of rule definitions.
RuleStatisticEntrySequence RuleStatisticEntry [] A sequence of Rule statistics.
VerificationStatusSequence VerificationStatus [] A sequence of rule verification status items.

See Also

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.