ltm rule command GTP ie

iRule(1)		      BIG-IP TMSH Manual		      iRule(1)



GTP::ie
       This set of commands allows for the parsing and interpretation of GTP
       IE elements.

SYNOPSIS
       GTP::ie 'exists' ('-message' MESSAGE)? (IE_PATH)?

       GTP::ie 'count'	('-message' MESSAGE)? ('-type' TYPE)? ('-instance'
       INSTANCE)? (IE_PATH)?

       GTP::ie 'get' ('instance' | 'length' | 'encode-type' | 'value')
       ('-message' MESSAGE)? IE_PATH

       GTP::ie 'get' 'list' ('-message' MESSAGE)? ('-type' TYPE)? ('-instance'
       INSTANCE)?  (IE_PATH)?

       GTP::ie 'set' ('instance' | 'value') ('-message' MESSAGE)? IE_PATH
       VALUE

       GTP::ie 'append' ('-message' MESSAGE)? (IE_PATH)? TYPE INSTANCE VALUE

       GTP::ie 'remove' ('-message' MESSAGE)? IE_PATH

       GTP::ie 'insert' ('-message' MESSAGE)? IE_PATH TYPE INSTANCE VALUE

       GTP::ie 'info' ANY_CHARS (ANY_CHARS)? (ANY_CHARS)?

       GTP::ie 'list'

DESCRIPTION
       This set of commands allows for the parsing and interpretation of GTP
       IE elements.

       Syntax

       GTP::ie exists []

	    * Helps verify if this IE exists. In the absence of ie-path, it
	      returns true, if at the least one IE element is present in the
	      message.

       GTP::ie count [-type ] [-instance ] []

	  The count of IEs held by referred path is returned that matches the
	  given type & instance, if the options are provided. The path provides
	  the scope for counting. Path has to be the last argument to the
	  command. The absence of path argument sets the message as the scope,
	  hence count of all IEs in the message is returned. If "-type " is
	  provided, only those IEs that matches this type within the scope are
	  counted. If "-instance " is provided, only those IEs that matches this
	  instance within the scope are counted.
	  NOTE: The count happens at the given scope, implying it does not
	  include any embedded IEs in the count. Say message has 3 IEs and one of
	  which is grouped-IE. Here "GTP::ie count" returns 3. GTP::ie count
	  bearer_context Returns count of embedded IEs in the first
	  bearer-context in the message. GTP::ie count Returns count of all IEs
	  in the message. GTP::ie-count -type ip-address pdn-conn Return the
	  count of IP address IEs inside the first PDN connection IE in the
	  message. Only first PDN Connection is used as absence of index in path
	  defaults to 0.

       GTP::ie get instance 

	  * Returns the instance value of this IE. For messages of version 1,
	  instance value is returned as 0.

       GTP::ie get length 

	    * Returns the length in octets of value of this IE

       GTP::ie get encode_type 

	    * Returns the type of encoding of the value.

       GTP::ie get value 

	  Returns the value of this IE as the TclList object of following
	  elements in the same order as listed below:
	  type: UINT8 index: UINT8 length: UINT16 instance: UINT8 encode_type:
	  Constant string as one of the defined encode types. value:

       GTP::ie get list [-type ] [-instance ] []

	  Returns list of IE objects in the contained scope. The scope is
	  provided by the path. path has to be the last argument. Absence of any
	  path set the message level as scope. * -type helps collect IEs that
	  matches this type value only. * -instance helps collect IEs of given
	  instance value only.
	  In case of messages of version 1, all elements are considered to have
	  instance value of 0. Each IE_object is same as the output for "GTP::ie aXXvalue "

       GTP::ie list

	   * Returns the list of all the IE elements contained in the message.

       GTP::ie info

	  List the following info for each IE supported in this version: * , , ,

       GTP::ie info

	  * Return the info as in GTP::ie info for the specified IE only.

       GTP::ie info

	  * Return the info as in GTP::ie info for the specified IE only.

       GTP::ie info -encode-type

	  * Returns only the encode type of the specified IE.

       GTP::ie info -encode-type

	  * Returns only the encode type of the specified IE.

       GTP::ie info -name

	  * Returns the name of specified IE.

       GTP::ie info -type

	  * Returns the type of specified IE.

RETURN VALUE
VALID DURING
EXAMPLES
HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-11.5.0 --First introduced the command.



BIG-IP				  2017-01-31			      iRule(1)