analytics vcmp report
analytics vcmp report(1) BIG-IP TMSH Manual analytics vcmp report(1)
NAME
report - Displays an vcmp analytics report.
MODULE
analytics vcmp
SYNTAX
Show, save or send an analytics vcmp report using the syntax shown in
the following sections.
DISPLAY
show report view-by [ guest | slot | interface | process-name ]
options:
drilldown {
{
entity [ guest | slot | interface | process-name ]
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 [ guest | slot | interface | process-name ]
options:
drilldown {
{
entity [ guest | slot | interface | process-name ]
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 [ guest | slot | interface | process-name ]
options:
drilldown {
{
entity [ guest | slot | interface | process-name ]
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 vcmp analytics reports. You can generate a
vCMP analytics report for the following entities:
o slot - Slot ID
o guest - vCMP Guest name
o interface - vCMP Interface
o process-name - Process name
Different measures are collected for each of these entities and can be
a part of the report request.
EXAMPLES
show analytics vcmp report view-by slot
show analytics vcmp report view-by slot drilldown { { entity slot
values { 5 } } }
send-mail analytics vcmp report view-by guest measures { network-bytes-
in } limit 20 order-by { { measure network-bytes-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:
network-bytes-in
The total number of external and internal bytes received for
the selected filter (entity).
network-bytes-out
The total number of external and internal bytes sent for the
selected filter (entity).
network-average-in-throughput
The average internal and external received throughput for the
selected filter (entity).
network-average-out-throughput
The average internal and external throughput sent for the
selected filter (entity).
average-guest-cpu-usage
The average number of CPU usage for the selected filter
(entity) relative to host CPU.
diskio-bytes-read
The average number of bytes read from disk for the selected
filter (entity).
diskio-bytes-written
The average number of bytes written to disk for the selected
filter (entity).
diskio-requests-read
The average number of read requests from disk for the
selected filter (entity).
diskio-requests-written
The average number of write requests from disk for the
selected filter (entity).
average-process-cpu-usage
The average number of CPU usage for the selected filter
(entity) normalized relatively to guest CPU.
traffic-client-new-connections
The total number of client-side new connections for the
selected filter (entity).
traffic-client-avg-connections
The average number of client-side connections opened for a
selected filter (entity).
traffic-client-packets-in
The total number of client-side received packets for a
selected filter (entity).
traffic-client-packets-out
The total number of client-side sent packets for a selected
filter (entity).
traffic-client-bytes-in
The total number of client-side received bytes for a selected
filter (entity).
traffic-client-bytes-out
The total number of client-side sent bytes for a selected
filter (entity).
traffic-server-new-connections
The total number of server-side new connections for the
selected filter (entity).
traffic-server-avg-connections
The average number of server-side connections opened for a
selected filter (entity).
traffic-server-packets-in
The total number of server-side received packets for a
selected filter (entity).
traffic-server-packets-out
The total number of server-side sent packets for a selected
filter (entity).
traffic-server-bytes-in
The total number of server-side received bytes for a selected
filter (entity).
traffic-server-bytes-out
The total number of server-side sent bytes for a selected
filter (entity).
total-assisted-connections
The total number of all hardware accelerated assisted
connections for a selected filter (entity).
current-assisted-connections
The average number of all hardware accelerated assisted
connections for a selected filter (entity).
hardware-syncookies-generated
The total number of SYN cookies generated for a selected
filter (entity).
hardware-syncookies-detected
The total number of SYN cookies detected for a selected
filter (entity).
hw-accel-client-packets-in
The total number of hardware accelerated client-side received
packets for a selected filter (entity).
hw-accel-client-packets-out
The total number of hardware accelerated client-side received
sent for a selected filter (entity).
hw-accel-client-bytes-in
The total number of hardware accelerated client-side received
bytes for a selected filter (entity).
hw-accel-client-bytes-out
The total number of hardware accelerated client-side sent
bytes for a selected filter (entity).
hw-accel-client-max-connections
The max number of hardware accelerated client-side
connections for a selected filter (entity).
hw-accel-client-new-connections
The total number of hardware accelerated client-side new
connections for a selected filter (entity).
hw-accel-client-current-connections
The average number of hardware accelerated client-side opened
connections for a selected filter (entity).
hw-accel-server-packets-in
The total number of hardware accelerated server-side received
packets for a selected filter (entity).
hw-accel-server-packets-out
The total number of hardware accelerated server-side received
sent for a selected filter (entity).
hw-accel-server-bytes-in
The total number of hardware accelerated server-side received
bytes for a selected filter (entity).
hw-accel-server-bytes-out
The total number of hardware accelerated server-side sent
bytes for a selected filter (entity).
hw-accel-server-max-connections
The max number of hardware accelerated server-side
connections for a selected filter (entity).
hw-accel-server-new-connections
The total number of hardware accelerated server-side new
connections for a selected filter (entity).
hw-accel-server-current-connections
The average number of hardware accelerated server-side opened
connections for a selected filter (entity).
tmm-total-ram
The average of total TMM memory for the selected filter
(entity).
tmm-used-ram
The average of used TMM memory for the selected filter
(entity).
tmm-free-ram
The average of free TMM memory for the selected filter
(entity).
other-total-ram
The average of total other (daemons and kernel) memory for
the selected filter (entity).
other-used-ram
The average of used other (daemons and kernel) memory for the
selected filter (entity).
other-free-ram
The average of free other (daemons and kernel) memory for the
selected filter (entity).
system-total-ram
The average of total system memory for the selected filter
(entity).
system-used-ram
The average of used system memory for the selected filter
(entity).
system-free-ram
The average of free system memory for the selected filter
(entity).
swap-total-ram
The average of total swap memory for the selected filter
(entity).
swap-used-ram
The average of used swap memory for the selected filter
(entity).
swap-free-ram
The average of free swap memory 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-2015. All rights reserved.
BIG-IP 2015-07-22 analytics vcmp report(1)