analytics ip-layer report
analytics ip-layer report(1) BIG-IP TMSH Manual analytics ip-layer report(1)
NAME
report - Displays an ip-layer analytics report.
MODULE
analytics ip-layer
SYNTAX
Show, save or send an analytics ip-layer report using the syntax shown
in the following sections.
DISPLAY
show report view-by [ ip ]
options:
drilldown {
{
entity [ ip ]
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 [ ip ]
options:
drilldown {
{
entity [ ip ]
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 [ ip ]
options:
drilldown {
{
entity [ ip ]
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 ip-layer analytics reports. You can
generate a IP-layer analytics report for the following entities:
o ip - IP version (IPV4 / IPV6)
Different measures are collected for each of these entities and can be
a part of the report request.
EXAMPLES
show analytics ip-layer report view-by ip
show analytics ip-layer report view-by ip drilldown { { entity ip
values { IP-V4 } } }
send-mail analytics ip-layer report view-by ip measures { dropped-pkts
} limit 20 order-by { { measure dropped-pkts 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:
transmitted-pkts
The total number of transmitted packets for the selected
filter (entity).
received-pkts
The total number of received packets for the selected filter
(entity).
dropped-pkts
The total number of dropped packets for the selected filter
(entity).
err-invalid-len
The total number of error invalid length for the selected
filter (entity).
err-memory
The total number of error memory for the selected filter
(entity).
err-retransmitted
The total number of error retransmitted for the selected
filter (entity).
err-protocol
The total number of error protocol for the selected filter
(entity).
err-options
The total number of error options for the selected filter
(entity).
err-checksum
The total number of error checksum for the selected filter
(entity).
received-frags
The total number of received fragments for the selected
filter (entity).
received_dropped_frags
The total number of received dropped fragments for the
selected filter (entity).
transmitted-frags
The total number of transmitted fragments for the selected
filter (entity).
transmitted-dropped-frags
The total number of transmitted dropped fragment for the
selected filter (entity).
reassembled-frags
The total number of reassembled fragment for the selected
filter (entity).
reassembled-dropped-frags
The total number of 'too long' reassembled dropped fragment
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 ip-layer report(1)