analytics tcp report
analytics tcp report(1) BIG-IP TMSH Manual analytics tcp report(1)
NAME
report - Displays an tcp analytics report.
MODULE
analytics tcp
SYNTAX
Show, save or send an analytics tcp report using the syntax shown in the following sections.
DISPLAY
show report view-by [ virtual | tcp ]
options:
drilldown {
{
entity [ virtual | tcp ]
values
{
[value ...]
}
} ...
}
field-fmt
include-total
include-others
limit [number of rows]
measures {
[measure name ...]
}
order-by {
{
measure [ measure name ]
sort-type [ asc / desc ]
} ...
}
range [date range]
SAVE
save report view-by [ virtual | tcp ]
options:
drilldown {
{
entity [ virtual | tcp ]
values
{
[value ...]
}
} ...
}
file [ file name ]
format [ csv-aggregated | csv-time-series | pdf ]
include-total
include-others
limit [number of rows]
measures {
[measure name ...]
}
order-by {
{
measure [ measure name ]
sort-type [ asc / desc ]
} ...
}
range [date range]
SEND
send-mail report view-by [ virtual | tcp ]
options:
drilldown {
{
entity [ virtual | tcp ]
values
{
[value ...]
}
} ...
}
email-addresses {
[email address ...]
}
format [ csv-aggregated | csv-time-series | pdf ]
include-total
include-others
limit [number of rows]
measures {
[measure name ...]
}
order-by {
{
measure [ measure name ]
sort-type [ asc / desc ]
} ...
}
range [date range]
smtp-config-override [ smtp configuration object name ]
DESCRIPTION
Use this command to generate tcp analytics reports. You can generate a TCP analytics report for the following
entities:
· virtual - Virtual Server
· tcp - TCP Profile
Different measures are collected for each of these entities and can be a part of the report request.
EXAMPLES
show analytics tcp report view-by virtual
show analytics tcp report view-by virtual drilldown { { entity virtual values { 172.12.34.56 } } }
send-mail analytics tcp report view-by tcp measures { max-active-conns } limit 20 order-by { { measure max-
active-conns sort-type desc } } format pdf email-addresses { some.one@someaddress.com }
For more syntactical examples, see the tmsh help manual for analytics report.
OPTIONS
device
Specifies a BIG-IP device on which to generate a report. (Enterprise Manager only)
device-list
Specifies a custom list of BIG-IP devices on which to generate a report. (Enterprise Manager only)
drilldown
Specifies specific entities that are used as a filter.
email-addresses
Specifies the list of email addresses to which the report file is sent when using the send-mail command.
file Specifies the exported file path to be saved when using the save command. The file name should be simple
(not a full path).
format
Specifies the exported file format to be saved or sent. This option must be specified when using the save
or send-mail commands.
include-others
Specifies that the grand total for the measure is displayed for all entities, except for those shown in
the result. It can be used along with include-total.
include-total
Specifies that a total summary row should be added to the analytics report. For average measures, the
total value is also an average.
limit
Specifies the maximum number of rows/entities in the output result set/file. The default value is 10, not
including the total row/entity. The maximum value is 1000.
measures
Specifies a list of measures that can be used with the chosen entity type. The options are:
avg-active-conns
The average number of actice connections for the selected filter (entity).
max-active-conns
The max number of active connections for the selected filter (entity).
total-accepts
The total number of accepted connections for the selected filter (entity).
total-accept_fails
The total number of denied accept connections for the selected filter (entity).
total-new-conns
The total number of new connections for the selected filter (entity).
total-failed-conns
The total number of failed connections for the selected filter (entity).
total-expired-conns
The total number of expired connections for the selected filter (entity).
total-abandoned-connections
The total number of abandoned connections for the selected filter (entity).
total-rst-packets
The total number of RST connections for the selected filter (entity).
total-malformed-segments
The total number of malformed connections for the selected filter (entity).
total-oo-segs
The total number of out of ordered segments for the selected filter (entity).
total-rx-cookie
The total number of received SYN cookies for the selected filter (entity).
total-rxbadcookies
The total number of received bad SYN cookies for the selected filter (entity).
total-hw-cookies
The total number of received HW SYN cookies for the selected filter (entity).
total-syncacheover
The total number of SYN cache overflow for the selected filter (entity).
total-txrexmits
The total number of retransmitted segments for the selected filter (entity).
total-sndpack
The total number of sent packets for the selected filter (entity).
order-by
Specifies the measures and sort type (ascending or descending) that will be used to sort the final
report. The value for each measure is a previously chosen measure. The default value for sort type is
desc (descending).
range
Specifies the time/date range of the analytics information that you want to display. The given results
will reflect the time range chosen here. The default value is the last hour (now--now-1h).
smtp-config-override
Specifies the SMTP configuration to use when sending reports by email. This overrides the default SMTP
settings.
SEE ALSO
show, save, send-mail, tmsh, ltm profile analytics, analytics, analytics report
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-2014. All rights reserved.
BIG-IP 2014-07-10 analytics tcp report(1)