Introduced : BIG-IP_v9.0
Queries the specified rules.


RuleDefinition [] query_rule(
    in String [] rule_names


Parameter Type Description
rule_names String [] The names of the rules to query.

Return Type

Type Description
RuleDefinition [] Returns the texts/definitions associated with the specified rules.


Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if one of the arguments is invalid.
Common::OperationFailed Raised if an operation error occurs.

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

  • Initialize Rule - This iControl sample will force the re-initialization of an iRule.
  • Java Object Ltm Rule - This Java class will wrap the iControl LTM Rule interface to make it look like an object.
  • Perl Add iRule To All Virtuals - This iControl application illustrates how to mass-deploy an iRule to all of the virtual servers on the system.
  • Perl Local Lb Rule - This Perl script illustrates how to use the methods in the LocalLB Rule interface for managing iRules.

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.