Log::IPFIXInformationElement¶
Introduced : BIG-IP_v11.6.0
The IPFIX Information Element (IE) interface enables you to get,
create, modify and delete IEs that are used to define standard IEs or
user defined IEs; to be able to filter via iRules the IEs that the
customer is interested in when enabling IPFIX destination as a log
destination. An Information Element is a protocol and
encoding-independent description of an attribute that may appear in an
IPFIX Record. The IPFIX information model [RFC5102] defines the base
set of Information Elements for IPFIX. The type associated with an
Information Element indicates constraints on what it may contain and
also determines the valid encoding mechanisms for use in IPFIX.
Methods¶
| Method | Description | Introduced |
| create | Creates an IPFIX IE. Notice that it is desirable to set the enterprise id to something different than the default zero. Zero is mainly used for the IPFIX information model [RFC5102] defined base elements. If data types include IPFIX_DATA_TYPE_STRING and/or IPFIX_DATA_TYPE_OCTETARRAY, the default size is zero, which means variable length. Specify sizes with the respective set method if your elements have a fixed length for those elements. | BIG-IP_v11.6.0 |
| delete_all_ipfix_elements | Deletes all user defined IPFIX Information Elements. | BIG-IP_v11.6.0 |
| delete_ipfix_element | Deletes the specified user IPFIX Information Element. | BIG-IP_v11.6.0 |
| get_data_type | Gets the data type for the specified IPFIX IEs. | BIG-IP_v11.6.0 |
| get_data_type_size | Gets the data data type size for the specified IPFIX IEs. | BIG-IP_v11.6.0 |
| get_description | Gets the descriptions for the specified IPFIX IEs. | BIG-IP_v11.6.0 |
| get_element_id | Gets the ids for the specified IPFIX IEs. | BIG-IP_v11.6.0 |
| get_enterprise_id | Gets the enterprise id for the specified IPFIX IEs. | BIG-IP_v11.6.0 |
| get_list | Gets the list of IPFIX Elements. | BIG-IP_v11.6.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.6.0 |
| set_data_type | Sets the data type for the specified IPFIX IEs. The IPFIX Information model [RFC5102] has defined a constrained set of data types for IEs to facilitate implementation. This is only applicable on user defined source elements. Base elements cannot change. | BIG-IP_v11.6.0 |
| set_data_type_size | Sets the sizes for the specified IPFIX IEs. It is only applicable for string and octetarray data types. Other data types ignore this value. Using 0 means the string or the octetarray has a variable length. The value must be in the range of 0 to 65535. This is only applicable on user defined source elements. Base elements cannot change. | BIG-IP_v11.6.0 |
| set_description | Sets the description for the specified IPFIX IEs. This is only applicable on user defined source elements. Base elements cannot change. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.6.0 |
| set_element_id | Sets the id for the specified IPFIX IEs. This is a numeric identifier of the Information Element. If this identifier is used without an enterprise identifier, then it is globally unique and the list of allowed values is administered by the Internet Assigned Numbers Authority (IANA). It is used for compact identification of an Information Element when encoding Templates in the protocol. This is only applicable on user defined source elements. Base elements cannot change. | BIG-IP_v11.6.0 |
| set_enterprise_id | Sets the enterprise id for the specified IPFIX IEs. It is set to zero by default. Enterprises may wish to define Information Elements without registering them with IANA, for example, for enterprise-internal purposes. For such IEs, the IE identifier described above is not sufficient when the IE is used outside the enterprise. If specifications of enterprise-specific IEs are made public and/or if enterprise-specific identifiers are used by the IPFIX protocol outside the enterprise, then the enterprise-specific identifier MUST be made globally unique by combining it with an enterprise identifier. Valid values for the enterpriseId are defined by IANA as Structure of Management Information (SMI) network management private enterprise codes. This is only applicable on user defined source elements. Base elements cannot change. | BIG-IP_v11.6.0 |
Enumerations¶
| Enumeration | Description |
| DataType | A list of IPFIX IE data types. The IPFIX Information model [RFC5102] has defined a constrained set of data types for IEs to facilitate implementation. |
| DefinitionSource | A list of IPFIX IE definition sources. There is a base set of IEs loaded on the BIGIP at boot time. These elements cannot be modified by the user. Any new element created shall be a user defined element, and this allows overriding the description of the base element without overwritting it. |
Aliases¶
| Alias | Type | Description |
| DataTypeSequence | DataType [] | A sequence of IPFIX IE data types. |
| DefinitionSourceSequence | DefinitionSource [] | A sequence of IPFIX IE definition sources. |
See Also¶
iControl ::
Warning
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¶
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.