sys log-config destination ipfix
sys log-config destination ipfix(1) BIG-IP TMSH Manual sys log-config destination ipfix(1)
NAME
ipfix - Formats log messages into IPFIX messages and sends them to a specified pool of IPFIX Collectors
MODULE
sys log-config destination
SYNTAX
CREATE/MODIFY
create ipfix [name]
modify ipfix [name]
options:
all
app-service [[string] | none]
description [string]
pool-name [string]
protocol-version [ipfix | netflow-9]
template-delete-delay [integer]
template-retransmit-interval [integer]
transport-profile [profile name]
serverssl-profile [profile name]
DISPLAY
list ipfix
list ipfix [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
DELETE
delete ipfix [name]
Note: You must remove all references to a destination before you can delete the destination. Default destinations may not
be deleted.
DESCRIPTION
You can use this destination component to create IPFIX forwarding destinations for the common logging interface.
The IPFIX protocol is designed for logging IP-transmission events. RFC 5101 ()
specifies the protocol, and RFC 5102 () describes the information model for IPFIX logs.
IPFIX logs are raw, binary-encoded strings with their fields and field lengths defined by IPFIX templates. IPFIX collectors
are external devices that can receive IPFIX templates and use them to interpret IPFIX logs.
EXAMPLES
create ipfix my_dest pool-name my_pool
Creates a destination named my_dest which sends IPFIX messages to the pool named my_pool.
delete ipfix my_dest
Deletes the destination named my_dest. Destinations cannot be deleted when in use by a publisher or another destination.
list ipfix my_dest
Displays properties of the destination named my_dest.
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 destination 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 destination. Only the application service can modify or delete the destination.
description
A user defined description for this logging destination.
glob Displays the items that match the glob expression. See help glob for a description of glob expression syntax.
name Specifies a unique name for the component. This option is required for the commands create, delete, and modify.
pool-name
Specifies the LTM pool that receives messages from the IPFIX destination. This option is required for the create
command. The pool should contain one or more IPFIX collectors; use the "ltm pool" component to set up an LTM pool.
protocol-version
Specifies the protocol version used to encode IPFIX messages sent by this logging destination. The possible values are
ipfix and netflow-9. The default is ipfix.
template-delete-delay
This feature is not implemented.
template-retransmit-interval
Specifies the time interval, in seconds, after which this IPFIX logging destination must resend all active IPFIX
Templates to the pool of IPFIX collectors.
The logging destination periodically retransmits all of its IPFIX templates at the interval you set in this property.
These retransmissions can be helpful if the transport-profile is UDP, a lossy transport mechanism. They can also be
useful for debugging a network session with a network analyzer, such as Wireshark.
The default value is 30 seconds.
transport-profile
Specifies the name of a profile for the transport protocol to be used by this IPFIX logging destination. You can use
any existing TCP-based or UDP-based profile. The default value is the default udp profile.
You can use the ltm profile tcp command (see "ltm profile tcp") to create a TCP profile, or ltm profile udp (see "ltm
profile udp") to create a UDP profile.
serverssl-profile
Specifies the name of a server-side SSL profile to be used by this IPFIX Log Destination. The default is not to use a
server-side SSL profile. If one is specified, the IPFIX Log Destination must be configured to use TCP as the transport
protocol, and will use SSL over TCP to communicate with the configured IPFIX collectors.
You can use the ltm profile server-ssl command (see "ltm profile server-ssl") to create a server-side SSL profile.
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
ltm pool, ltm profile tcp, ltm profile udp, 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 2008, 2013, 2016. All rights reserved.
BIG-IP 2016-03-14 sys log-config destination ipfix(1)