analytics dos-vis-vips report
analytics dos-vis-vips report(1) BIG-IP TMSH Manual analytics dos-vis-vips report(1)
NAME
report - Displays a DoS Virtual Servers analytics report.
MODULE
analytics dos-vis-vips
SYNTAX
Show, save or send a analytics dos-vis-vips 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 DoS Virtual Servers analytics reports. You can generate a DoS Virtual Servers analytics report
for the following entities:
• virtual - Name of the virtual server.
Different measures are collected for each of these entities and can be a part of the report request.
EXAMPLES
show analytics dos-vis-vips report view-by virtual
show analytics dos-vis-vips report view-by virtual drilldown { { entity virtual values { virtual_1 virtual_2 } } }
send-mail analytics dos-vis-vips report view-by virtual measures { avg-client-side-concurrent-conns } limit 20 order-by { {
measure avg-client-side-concurrent-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-abandoned-conns
Average number of abandoned connections per second.
avg-client-in-pps
Average packets rate in from clients per second.
avg-client-in-throughput
Average bits rate in from clients per second.
avg-client-out-pps
Average packets rate out to clients per second.
avg-client-out-throughput
Average bits rate outs to clients per second.
avg-client-side-concurrent-conns
Average client side concurrent connections.
avg-expired-conns
Average number of expired connections per second.
avg-failed-conns
Average number of failed connections per second.
avg-new-client-conns
Average number of new client side connections per second.
avg-new-server-conns
Average number of new server side connections per second.
avg-server-in-pps
Average packets rate in from servers per second.
avg-server-in-throughput
Average bits rate in from servers per second.
avg-server-latency
Average server latency (in ms).
avg-server-latency-health
Health score of the Latency parameter.
avg-server-out-pps
Average packets rate out to servers per second.
avg-server-out-throughput
Average bits rate out to servers per second.
avg-server-side-concurrent-conns
Average server side concurrent connections.
avg-throughput-health
Health score of the Throughput parameter.
concurrent-attacking-ips
The number of monitored simultaneous IPs participating in attacks per 10 second interval.
concurrent-blocked-ips
The number of monitored simultaneous blocked IPs per 10 second interval.
concurrent-conns-health
Health score of the Connections parameter.
concurrent-ips
The number of monitored simultaneous IP connections per 10 second interval.
max-concurrent-attacks
The number of monitored simultaneous attacks per 10 second interval.
max-concurrent-attacks-overtime
The at least number of simultaneous attacks per 10 second interval.
max-concurrent-client-conns
Highest number of simultaneous client side connections observed.
max-concurrent-server-conns
Highest number of simultaneous server side connections observed.
special-concurrent-ips-for-all-vips
The least number of simultaneous IPs connections per 10 second interval for all VIPs.
total-abandoned-conns
Total number of abandoned connections.
total-client-in-bytes
Total bytes in from clients.
total-client-out-bytes
The total client out bytes.
total-expired-conns
Total number of expired connections.
total-failed-conns
Total number of failed connections.
total-health
Overall health score of the virtual server (in %).
total-new-client-conns
Total number of new client side connections.
total-new-server-conns
Total number of new server side connections.
total-server-in-bytes
Total bytes in from servers.
total-server-out-bytes
Total bytes out to servers.
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-2018. All rights reserved.
BIG-IP 2018-07-04 analytics dos-vis-vips report(1)