BIG-IP LTM v11.5.0

Commands Introduced in BIG-IP LTM 11.5.0

  • ASM::client_ip - Returns the IP address of the end client that sent the present request
  • ASM::raise - Issues a user-defined violation on the present request
  • ASM::severity - Returns the overall severity of the violations found in the transaction (both request and response)
  • ASM::status - Returns the current status of the request or response
  • ASM::support_id - Returns the support id of the present HTTP transaction
  • ASM::unblock - Overrides the blocking action for a request that had blocking violation
  • ASM::violation - Returns the list of violations found in the present request or response together with details on each one
  • ASN1::decode - used to decode ASN.1 records
  • ASN1::element - returns ASN1.1 record elements
  • ASN1::encode - used to encode ASN.1 records
  • CATEGORY::lookup - returns the category of the supplied URL
  • CLASSIFICATION::app - provides classification for the most explicit application name
  • CLASSIFICATION::category - provides classification category name
  • CLASSIFICATION::disable - disables classification for the current flow
  • CLASSIFICATION::enable - enables classification for the current flow
  • CLASSIFICATION::protocol - provides classification for the least explicit application name
  • CLASSIFICATION::urlcat - provides classification url category name
  • CLASSIFY::urlcat - allows you to set or add an url category to the classification.
  • DNS::is_wideip - returns status (true/false) if a string is a configured wide IP.
  • DNS::scrape - allows users to walk over a DNS message and parse out information from the packet based on user supplied arguments
  • DNS::tsig - manipulates the current DNS message and its TSIG resource record.
  • FIX::tag - defines/deletes the mapping between senderCompID and a tag map data group
  • FLOW::priority - used to overwrite the flow’s internal packet priority
  • FTP::port - allows restriction of FTP ephemeral ports
  • GENERICMESSAGE::message - returns or sets values in the message routing framework
  • GENERICMESSAGE::peer - returns or sets the peer’s route name
  • GENERICMESSAGE::route - add, delete, or lookup message routes
  • GTP::discard - Discards the current message
  • GTP::header - Allows for the parsing of GTP header information.
  • GTP::header extension - The extension headers are identified by unique type values. The type can be appended with index, if multiple headers of same type are expected.
  • GTP::ie - This set of commands allows for the parsing and interpretation of GTP IE elements.
  • GTP::length - This value is returned as read from the message header.
  • GTP::message - Returns the entire GTP message.
  • GTP::payload - Returns the entire payload for G-PDU message. This command returns an empty value, in case of non-G-PDU messages.
  • GTP::tunnel - These commands parse the payload of G-PDU as IP datagram and return the values from IP header and TCP/UDP header.
  • HTTP::passthrough_reason - returns the reason for the most recent switch to pass-through mode by the HTTP filter
  • IPFIX::destination - open and close IPFIX logging destinations
  • IPFIX::msg - create, delete and set data values in an IPFIX message based on the provided IPFIX_TEMPLATE.
  • IPFIX::template - create and delete user defined IPFIX message templates
  • llookup - returns a list of values corresponding to the given key
  • MR::flow_id - returns a unique identifier for the current connection
  • MR::instance - returns the name of the current mr_router instance
  • MR::message - returns or sets details in the message routing table
  • MR::peer - defines a peer to use for routing a message to
  • MR::protocol - returns ‘generic, ‘sip’ or ‘diameter’
  • MR::restore - returns the stored variables to the current context tcl variable store
  • MR::store - stores a tcl variable with the mr_message object
  • MR::transport - returns the name and type (virtual or config) of the transport used to configure the current connection
  • PCP::reject - provides the ability to cause a PCP reqeust to fail based on processing in the iRule
  • PCP::request - provides access to the data sent in a PCP request
  • PCP::response - provides access to the data in a PCP response packet
  • PEM::flow - retrieves specific statistics from the flow report
  • QOE::disable - disables the video QOE filter from processing any video or non-video traffic on a connection basis
  • QOE::enable - enables the video QOE filter and allows processing video on a connection basis
  • QOE::video - returns a set of video QOE attributes from teh current video connection
  • REST::send - Send a rest request locally to the Big-IP REST Framework
  • SMTPS::disable - disables the SMTPS profile
  • SMTPS::enable - enables the SMTPS profile
  • SOCKS::allowed - enables the user to allow/reject SOCKS requests.
  • SOCKS::destination - enables the user to query and/or set parts of the requested connection
  • SOCKS::version - returns the SOCKS version
  • SSL::forward_proxy - sets the SSL forward proxy bypass feature to bypass or intercept.
  • SSL::sessionticket - returns the session ticket associated with the SSL flow
  • TDS::msg - returns TDS message data
  • TDS::session - returns TDS session data
  • TMM::cmp_primary_group - returns the CMP cluster primary
  • traffic_group - returns the current traffic group

Events Introduced in BIG-IP LTM 11.5.0

  • ASM_REQUEST_DONE - triggered after ASM finished processing the request and found all violations of the ASM policy
  • CLASSIFICATION_DETECTED - triggered when a flow is classified
  • CLIENTSSL_SERVERHELLO_SEND - Triggered when the system is about to send its SSL ServerHello message on the clientside connection
  • FIX_MESSAGE - Triggered when the system finishes parsing a new FIX message.
  • GENERICMESSAGE_EGRESS - raised when a message is received from the proxy
  • GENERICMESSAGE_INGRESS - raised when a message is received by the generic message filter
  • GTP_SIGNALLING_INGRESS - Triggered for any GTP-message except G-PDU on the connection that accepted the message
  • HTTP_DISABLED - triggered when HTTP is disabled
  • HTTP_PROXY_REQUEST - Triggered when a virtual server has proxy-mode explicit
  • MR_EGRESS - raised after the route has been selected and processed and the message is delivered to the mr_proxy
  • MR_INGRESS - raised when a message is received by the message proxy and before a route lookup occurs
  • MR_FAILED - raised when a message has been returned to the originating flow due to a routing failure
  • PCP_REQUEST - triggered on receipt of a valid PCP request from a client
  • PCP_RESPONSE - Triggered when a PCP response, successful or not, is returned to the client.
  • QOE_PARSE_DONE - triggered when the system finishes parsing the static video parameters from video header part.
  • SOCKS_REQUEST - triggered upon receipt of a SOCKS command on a SOCKS connection, before authentication is done.
  • TDS_REQUEST - triggered when a TDS request message is received.
  • TDS_RESPONSE - triggered when a TDS response message is received.

Commands Deprecated or Removed in BIG-IP LTM 11.5.0


Events Deprecated or Removed in BIG-IP LTM 11.5.0


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.