analytics virtual report
analytics virtual report(1) BIG-IP TMSH Manual analytics virtual report(1)
NAME
report - Displays an virtual analytics report.
MODULE
analytics virtual
SYNTAX
Show, save or send an analytics virtual report using the syntax shown
in the following sections.
DISPLAY
show report view-by [ virtual ]
options:
drilldown {
{
entity [ virtual ]
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 ]
options:
drilldown {
{
entity [ virtual ]
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 ]
options:
drilldown {
{
entity [ virtual ]
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 virtual analytics reports. You can
generate a VIP analytics report for the following entities:
o virtual - Virtual Server
Different measures are collected for each of these entities and can be
a part of the report request.
EXAMPLES
show analytics virtual report view-by virtual
show analytics virtual report view-by virtual drilldown { { entity
virtual values { 172.12.34.67 } } }
send-mail analytics virtual report view-by virtual measures { total-
server-packets-in } limit 20 order-by { { measure total-server-packets-
in 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:
total-client-packets-in
The total number of client-side received packets for the
selected filter (entity).
total-client-packets-out
The total number of client-side sent packets for the selected
filter (entity).
total-server-packets-in
The total number of server-side received packets for the
selected filter (entity).
total-server-packets-out
The total number of server-side sent packets for the selected
filter (entity).
total-client-bits-in
The total number of client-side received bits for the
selected filter (entity).
total-client-bits-out
The total number of client-side sent bits for the selected
filter (entity).
total-server-bits-in
The total number of server-side received bits for the
selected filter (entity).
total-server-bits-out
The total number of server-side sent bits for the selected
filter (entity).
total-client-conns
The total number of client-side connections for the selected
filter (entity).
avg-client-concurrent-conns
The average number of client-side concurrent connections for
the selected filter (entity).
max-client-concurrent-conns
The max value of client-side concurrent connections for the
selected filter (entity).
total-server-conns
The total number of server-side connections for the selected
filter (entity).
avg-server-concurrent-conns
The average number of server-side concurrent connections for
the selected filter (entity).
max-server-concurrent-conns
The max value of server side concurrent connections for the
selected filter (entity).
total-syncookies
The total number of syncookies for the selected filter
(entity).
total-syncookies-accepts
The total number of accepted syncookies for the selected
filter (entity).
total-syncookies-rejects
The total number of rejected syncookies for the selected
filter (entity).
total-hw-syncookies
The total number of HW syncookies for the selected filter
(entity).
total-hw-syncookies-accepts
The total number of accepted HW syncookies 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-23 analytics virtual report(1)