GLOBAL

Description

Global commands are meant to be used with any protocol.

Command List

  • accumulate - Terminates iRule processing until more data is received.
  • ACL::eval - enforces ACLs in your connections
  • active_members - Returns the number or list of active members in the specified pool.
  • active_nodes - Returns the alias for active members of the specified pool (for BIG-IP version 4.X compatibility).
  • after - Execute iRules code after a set period of delay.
  • b64decode - Returns a string that is base-64 decoded
  • b64encode - Returns a string that is base-64 encoded. or if an error occurs. an empty string.
  • BIGTCP::release_flow - Transition layer 7 FIX message to layer 4
  • call - Call an iRule procedure
  • CATEGORY::lookup - returns the category of the supplied URL
  • class - Advanced access of classes
  • client_addr - Returns the client IP address of a connection.
  • client_port - Returns the TCP port number/service of the specified client.
  • clientside - Causes the specified iRule commands to be evaluated under the client-side context.
  • clone - Causes the system to clone traffic to the specified pool or pool member regardless of monitor status.
  • CONNECTOR::disable - disables all the connectors on chain
  • CONNECTOR::enable - enables all the connectors on chain
  • cpu - The cpu usage command returns the average TMM cpu load for the given interval.
  • crc32 - Returns the crc32 checksum for the specified string.
  • decode_uri - Decodes the specified string using HTTP URI encoding.
  • DECOMPRESS::disable - Disable DECOMPRESS feature on current flow.
  • DECOMPRESS::enable - Enable DECOMPRESS feature on current flow.
  • DEMANGLE::disable -
  • DEMANGLE::enable -
  • discard - Causes the current packet or connection to be dropped/discarded. Same as the drop command.
  • DNSMSG::header -
  • DNSMSG::record -
  • DNSMSG::section -
  • domain - Parses the specified string as a dotted domain name and returns the last portions of the domain name.
  • drop - Causes the current packet or connection to be dropped/discarded. Same as the discard command.
  • event - Enables or disables evaluation of the specified iRule event. or all iRule events. on this connection.
  • findclass - Searches a data group list for a member that starts with a specified string and returns the data-group member string.
  • findstr - Finds a string within another string and returns the string starting at the offset specified from the match.
  • forward - Sets the connection to forward IP packets.
  • FTP::port - allows restriction of FTP ephemeral ports
  • getfield - Splits a string on a character or string. and returns the string corresponding to the specific field.
  • HA::status - Returns true or false based on whether the unit the command is executed on is active or standby
  • htonl - Convert the unsigned integer from host byte order to network byte order.
  • htons - Convert the unsigned short integer from host byte order to network byte order.
  • http_cookie - Specifies the value in the Cookie: header.
  • http_header - Evaluates the string following an HTTP header tag that you specify.
  • http_host - Specifies the value in the Host: header of the HTTP request.
  • http_method - Specifies the action of the HTTP request.
  • http_uri - Specifies a URI.
  • http_version - Specifies the HTTP protocol version.
  • ifile - returns content and attributes from external files on the BIG-IP system
  • imid - Returns an i-mode identifier string.
  • ip_addr - Returns the IP address of a tmm, tmm interface, localhost, etc
  • ip_protocol - Returns the IP protocol value.
  • ip_tos - Returns the ToS level of a packet.
  • ip_ttl - Returns the TTL of the latest IP packet received.
  • lasthop - Sets the lasthop of an IP connection.
  • link_qos - Returns the QoS level.
  • listen - Sets up a related ephemeral listener to allow an incoming related connection to be established.
  • llookup - returns a list of values corresponding to the given key
  • local_addr - Deprecated: Use IP::local_addr instead
  • log - Generates and logs a message to the syslog-ng utility.
  • matchclass - Performs comparison against the contents of data group.
  • matchregion - Returns true/false if specified region is matched.
  • md5 - Returns the RSA MD5 Message Digest Algorithm message digest of the specified string.
  • members - List all members of a given pool for v10.x.x
  • nexthop - Sets the nexthop of an IP connection.
  • node - Sends the packet directly to the identified server node.
  • nodes - List all nodes within a given pool
  • ntohl - Convert the unsigned integer from network byte order to host byte order.
  • ntohs - Convert the unsigned short integer from network byte order to host byte order.
  • Operators - iRules operators
  • peer - Causes the specified iRule commands to be evaluated under the peer’s (opposite) context.
  • pem_dtos - Query the TAC DB for IMEI value
  • persist - Causes the system to use the named persistence type to persist the connection.
  • pool - Causes the system to load balance traffic to the specified pool or pool member regardless of monitor status.
  • priority - The priority command is used to set the order that like iRule events are executed.
  • rateclass - Causes the system to select the specified rate class to use when transmitting packets.
  • redirect - Redirects an HTTP request to a specific location.
  • reject - Causes the connection to be rejected.
  • relate_client - Sets up a related established connection.
  • relate_server - Sets up a related established connection.
  • remote_addr - Deprecated: Use IP::remote_addr instead
  • RESOLV::lookup - Performs a DNS query for A or PTR records corresponding to a hostname or IP address.
  • RESOLVER::summarize -
  • RESOLVER::name_lookup -
  • REST::send - Send a rest request locally to the Big-IP REST Framework
  • return - Causes immediate exit from the currently executing event in the currently executing iRule.
  • rmd160 - Returns the RIPEMD-160 message digest of the specified string.
  • server_addr - Returns the IP address of the server.
  • server_port - Returns the TCP port/service number of the specified server.
  • serverside - Causes the specified iRule command to be evaluated under the server-side context.
  • session - Utilizes the persistence table to store arbitrary information based on the same keys as persistence.
  • sha1 - Returns the SHA version 1.0 message digest of the specified string.
  • sha256 - Returns the Secure Hash Algorithm (SHA2) 256-bit message digest of the specified string.
  • sha384 - Returns the Secure Hash Algorithm (SHA2) 384-bit message digest of the specified string.
  • sha512 - Returns the Secure Hash Algorithm (SHA2) 512-bit message digest of the specified string.
  • sharedvar - Allows a variable to be accessed in both sides of a VIP-targetting-VIP
  • snat - Causes the LTM system to assign the specified translation address to the current connection.
  • snatpool - Causes the specified pool of addresses to be used as translation addresses to create a SNAT.
  • substr - A custom iRule function which returns a substring from a string
  • table - The table command provides enhanced access to the session table
  • tcl_platform - A variable that contains platform specific information
  • timing - Enable and disable iRule timing statistics.
  • TMM::cmp_count - Provides the active number of TMM instances running.
  • TMM::cmp_group - Returns the number (0-x) of the group of the CPU executing the rule. Typically a group refers to the blade number on a chassis system. and is always 0 on other platforms.
  • TMM::cmp_unit - Returns the number (0-x) of the CPU executing the rule.
  • traffic_group - returns the current traffic group
  • translate - Enables, disables, or queries (as specified) destination address or port translation
  • urlcatblindquery - Query the encrypted URL for URL categorization
  • urlcatquery - Query the URL for URL categorization
  • use - A BIG-IP 4.X statement. provided for backward-compatibility.
  • VALIDATE::protocol - allows you to validate payload (traffic) to match given classification application
  • virtual - Return the name of the associated virtual server or selects another virtual server.
  • vlan_id - Returns the VLAN tag of the packet.
  • when - Used to specify an event in an iRule.
  • whereis - Returns geographical information on an IP address.

Associated Events

  • EPI_NA_CHECK_HTTP_REQUEST - triggered when special http request comes
  • FLOW_INIT - triggered (once for TCP and unique UDP/IP flows) after packet filters
  • LB_FAILED - Triggered when the system fails to select a pool or a pool member. or when a selected resource is unreachable.
  • LB_SELECTED - Triggered when the system selects a pool member.
  • NAME_RESOLVED - Triggered after a NAME::lookup command has been issued and a response has been received.
  • PERSIST_DOWN - Triggered when persistence dictates that a connection would be sent to a pool or a pool member or node which has been marked down.
  • PING_REQUEST_READY - triggered when TMM has assembled an HTTP request to PingAccess policy server
  • PING_RESPONSE_READY - triggered when TMM has received an HTTP response from PingAccess policy server
  • RULE_INIT - Triggered when an iRule is added or is modified.
  • SA_PICKED - triggered after source translation is completed.
  • SERVER_INIT - triggered when BIG-IP has been configured to collect options and serverside TCP SYN is sent

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.