iRules configuration

REST Endpoints

Collection URI
Collection Methods
Resource URI
/mgmt/tm/ltm/rule/~resource id
Resource Methods
Resource Natural Key
name, partition, subPath


Name Type Default Value Required Access Description
action string none optional read/write  
appService string   optional read/write The application service to which the object belongs.
definitionChecksum string   optional read/write  
definitionSignature string   optional read/write  
hidden boolean   optional read/write  
ignoreVerification string   optional read/write  
nodelete boolean   optional read/write  
nowrite boolean   optional read/write  
tmPartition string   optional read/write Displays the administrative partition within which this iRule resides.
plugin string   optional read/write  
publicCert string   optional read/write The public certificate corresponding to the signing-key.
signingKey string   optional read/write The private key to use for signing the iRule. This is used only with the generate signature command.

Array Structures

Name Type Default Value Required Access Description
/metadata array_structure   optional read/write User defined generic data for the rule. It is a name and value pair.
/metadata/app-service string   optional read/write  
/metadata/persist string true optional read/write Specifies whether the command “tmsh save sys config” will save the metadata entry to the configuration files.
/metadata/value string   optional read/write Value of the rule metadata
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

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.