analytics afm-sweeper report
analytics afm-sweeper report(1) BIG-IP TMSH Manual analytics afm-sweeper report(1)
NAME
report - Displays an afm-sweeper analytics report.
MODULE
analytics afm-sweeper
SYNTAX
Show, save or send an analytics afm-sweeper report using the syntax shown in the following sections.
DISPLAY
show report view-by [ policy-name | context-type | context-name | eviction-reason | client-ip ]
options:
drilldown {
{
entity [ policy-name | context-type | context-name | eviction-reason | client-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 [ policy-name | context-type | context-name | eviction-reason | client-ip ]
options:
drilldown {
{
entity [ policy-name | context-type | context-name | eviction-reason | client-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 [ policy-name | context-type | context-name | eviction-reason | client-ip ]
options:
drilldown {
{
entity [ policy-name | context-type | context-name | eviction-reason | client-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 afm-sweeper analytics reports. You can generate an afm-sweeper analytics report for the
following entities:
• policy-name - Name of the sweeper policy.
• context-type - The context type of the eviction. Can be one of three possible values: "Virtual Server", "Route
Domain", "Global".
• context-name - The name of the context. Depends on the context-type this value can be either a virtual server name
(e.g. "my_vs1"), route domain id (e.g. 317) or "Global".
• eviction-reason - The algorithm used by sweeper that caused the eviction of a connection.
• client-ip - The source IP of the evicted connection.
Different measures are collected for each of these entities and can be a part of the report request.
EXAMPLES
show analytics afm-sweeper report view-by client-ip
show analytics afm-sweeper report view-by client-ip drilldown { { entity context-type values { Global } } }
send-mail analytics afm-sweeper report view-by client-ip measures { avg-connections-age } limit 15 order-by { { measure
avg-connections-age 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-connections-age
The average time that the connections lasted before evicted for the selected filter (entity).
evicted-connections
The total number of evicted connections for the selected filter (entity).
total-bytes-in
The total number of bytes received for the selected filter (entity).
total-bytes-out
The total number of bytes sent 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-2013, 2015. All rights reserved.
BIG-IP 2016-03-14 analytics afm-sweeper report(1)