sys ipfix element

sys ipfix element(1)				  BIG-IP TMSH Manual				 sys ipfix element(1)

NAME
       element - Configures element for IPFIX logging.

MODULE
       sys ipfix

SYNTAX
       Configure the IPFIX component within the sys ipfix module using the syntax shown in the following sections.

   CREATE/MODIFY
	create element [name]
	modify element [name]
	 options:
	  all
	  app-service [[string] | none]
	  data-type
	     [ boolean | datetime-microseconds |
	       datetime-milliseconds | datetime-nanoseconds |
	       datetime-seconds | float32 | float64 |
	       ipv4-address | ipv6-address | macaddress |
	       octetarray | signed16 | signed32 | signed64 |
	       signed8 | string |
	       unsigned16 | unsigned32 |
	       unsigned64 | unsigned8 ]
	  description [string]
	  enterprise-id [integer]
	  id [integer]
	  size [integer]

   DISPLAY
	list element
	list element [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    one-line

   DELETE
	delete element [name]

       Note: Default elements loaded at boot time may not be deleted.

DESCRIPTION
       You can use the element component to configure elements for the IPFIX logging interface.

EXAMPLES
       create element myelement id 345 enterprise-id 543 data-type string size 128

       Creates a element named myelement with element id  345, enterprise-id  543, data-type  string and data size of
       128.

       delete element myelement

       Deletes the element named myelement.

       list element myelement

       Displays properties of the element named myelement.

OPTIONS
       all  Specifies that you want to modify all of the existing components of the specified type.

       app-service
	    Specifies the name of the application service to which the element belongs.  The default value is none.
	    Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
	    modify or delete the element. Only the application service can modify or delete the element.

       data-type
	    Specifies the data type of the element.

       description
	    User defined description.

       enterprise-id
	    Specifies the enterprise-id for the IPFIX element being configured between 0 and 4294967295.  An
	    enterprise id value of 0 is used to define standardized IANA Information Elements.

       id   Specifies the element id for the IPFIX element being configured between 1 and 65535. Values greater than
	    32767 will be considered NETFLOW-only Information Elements; since the high bit of the 16-bit value is set
	    for those values.

       size Specifies the IPFIX element data size between 1 and 1900 for data-types octetarray and string.  The
	    default is 0; and means variable for these two data-types.

       glob Displays the items that match the glob expression. See help glob for a description of glob expression
	    syntax.

       name Specifies a unique alphanumeric name for the component. Preferably camel casing. This option is required
	    for the commands create, delete, and modify.

       regex
	    Displays the items that match the regular expression. The regular expression must be preceded by an at
	    sign (@[regular expression]) to indicate that the identifier is a regular expression. See help regex for
	    a description of regular expression syntax.

SEE ALSO
       create, delete, glob, list, modify, regex, tmsh

COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or by any means, electronic or
       mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
       other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2014. All rights reserved.

BIG-IP						      2014-05-28				 sys ipfix element(1)