ltm profile tcpanalytics
ltm profile tcpanalytics(1) BIG-IP TMSH Manual ltm profile tcpanalytics(1)
NAME
tcp-analytics - Configures a TCP Analytics profile.
MODULE
ltm profile
SYNTAX
Configure the tcp-analytics component within the ltm profile module
using the syntax shown in the following sections.
CREATE/MODIFY
create tcp-analytics [name]
modify tcp-analytics [name]
options:
collected-by-client-side [disabled | enabled]
collected-by-server-side [disabled | enabled]
collected-stats-external-logging [disabled | enabled]
collected-stats-internal-logging [disabled | enabled]
collect-city [disabled | enabled]
collect-continent [disabled | enabled]
collect-country [disabled | enabled]
collect-nexthop [disabled | enabled]
collect-post-code [disabled | enabled]
collect-region [disabled | enabled]
collect-remote-host-ip [disabled | enabled]
collect-remote-host-subnet [disabled | enabled]
defaults-from [ [name] | none]
description [string]
external-logging-publisher [string]
edit tcp-analytics [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list tcp-analytics
list tcp-analytics [ [ [name] | [glob] | [regex] ] ... ]
show running-config tcp-analytics
show running-config tcp-analytics
[ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show tcp-analytics
show tcp-analytics [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
global
DELETE
delete tcp-analytics [name]
DESCRIPTION
You can use the tcp-analytics component to generate detailed TCP
statistics for virtuals that have a TCP or FastL4 profile, if AVR is
provisioned. The options specify where the data is collected and
stored, and which connection identifiers ("entities") users can query
the data with.
In general, storing more entities increases the ability to drill down
to specific connections. However, if AVR hits its memory limits it will
begin to aggregate new connections and reduce this resolution. If a
virtual serves a very high number of IP addresses, for example, it is
best to store data using collect-remote-host-subnet, or use the
TCP::analytics iRule to enhance collection for a set of IP addresses of
interest.
The system installation includes the default profile tcp-analytics. You
can modify the settings of this profile, or create new TCP analytics
profiles using it as a parent profile.
EXAMPLES
create ltm profile tcp-analytics my_tcpanalytics_profile defaults-from
tcp-analytics
Creates a custom TCP profile named my_tcpanalytics_profile that
inherits its settings from the system default tcp-analytics profile.
list ltm profile tcp-analytics all-properties
Displays all properties for all TCP profiles
OPTIONS
collected-by-client-side
When enabled, client side connections collect TCP analytics data
unless directed otherwise by iRule. If false, client side
connections only collect data if directed by iRule. The default
value is enabled.
collected-by-server-side
When enabled, server side connections collect TCP analytics data
unless directed otherwise by iRule. If false, server side
connections only collect data if directed by iRule. The default
value is disabled.
collected-stats-external-logging
When enabled, TCP statistics are logged on a remote machine
determined by external-logging-publisher. The default value is
disabled.
collected-stats-internal-logging
When enabled, TCP statistics are logged on the local BIG-IP. The
default value is enabled.
collect-city
When enabled, AVR stores the city (from the GeoIP database) for
the remote IP address of the connection with TCP statistics. See
SOL11176 on support.f5.com for more on GeoIP. The default value is
disabled.
collect-continent
When enabled, AVR stores the continent (from the GeoIP database)
for the remote IP address of the connection with TCP statistics.
See SOL11176 on support.f5.com for more on GeoIP. The default
value is enabled.
collect-country
When enabled, AVR stores the country (from the GeoIP database) for
the remote IP address of the connection with TCP statistics. See
SOL11176 on support.f5.com for more on GeoIP. The default value is
enabled.
collect-nexthop
When enabled, AVR stores the nexthop ethernet address of the
connection with TCP statistics. The default value is disabled.
collect-post-code
When enabled, AVR stores the postcode (from the GeoIP database)
for the remote IP address of the connection with TCP statistics.
See SOL11176 on support.f5.com for more on GeoIP. The default
value is disabled.
collect-region
When enabled, AVR stores the region (from the GeoIP database) for
the remote IP address of the connection with TCP statistics. See
SOL11176 on support.f5.com for more on GeoIP. The default value is
disabled.
collect-remote-host-ip
When enabled, AVR stores the remote host IP address with TCP
statistics. The default value is disabled.
collect-remote-host-subnet
When enabled, AVR stores the remote host IP subnet (24-bit) with
TCP statistics. The default value is enabled.
defaults-from
Specifies the profile that you want to use as the parent profile.
Your new profile inherits all settings and values from the parent
profile. The default value is tcp-analytics.
description
User defined description.
external-logging-publisher
The name of the publisher to accept external logging.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, regex, reset-
stats, show, 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-2015. All rights reserved.
BIG-IP 2015-08-28 ltm profile tcpanalytics(1)