analytics pool-traffic scheduled-report
analytics pool-traffic scheduled-report(1) BIG-IP TMSH Manual analytics pool-traffic scheduled-report(1)
NAME
scheduled-report - Configure scheduled reports for pool traffic.
MODULE
analytics pool-traffic
SYNTAX
Configure the scheduled-report component within the analytics pool-traffic module using the syntax shown in the following
sections.
CREATE/MODIFY
create scheduled-report [name]
modify scheduled-report [name]
options:
email-addresses [none | add | delete | modify |
replace-all-with] { email-address [string] }
first-time [date]
frequency [every-6-hours | every-12-hours | every-24-hours | every-week | every-month]
include-total [enabled | disabled]
multi-leveled-report {
chart-path [none | add | delete | modify | replace-all-with] { entity name [string] }
limit [number of rows]
time-diff [last-hour | last-day | last-week | last-month | last-year]
view-by { entity name [string] }
measures [none | add | delete | modify | replace-all-with] { measure name [string] }
}
predefined-report-name [name]
smtp-config [name]
device-group [name]
DISPLAY
list scheduled-report
list scheduled-report [ [ [name] | [glob] | [regex] ] ... ]
show running-config scheduled-report
show running-config scheduled-report [ [ [name] | [glob] | [regex] ] ... ]
DELETE
delete scheduled-report [name]
DESCRIPTION
Use the scheduled-report component to create, modify or delete scheduled reports for the pool traffic module.
EXAMPLES
create scheduled-report myScheduledReport first-time now predefined-report-name "Top blocked URLs" frequency every-6-hours
email-addresses add { person@domain.com } smtp-config asm_smtp_conf
Creates a scheduled report, starting from the next hour and executing every 6 hours. The report contains a PDF showing
statistics for the top blocked URLs and is sent to person@domain.com using the smtp configuration defined in asm_smtp_conf.
modify scheduled-report myScheduledReport smtp-config none
Set smtp configuration of the scheduled report "myScheduledReport" to none, thus effectively disabling the scheduled report
from begin generated and sent over eMail.
create scheduled-report myCustomScheduledReport first-time now email-addresses add { person@domain.com } frequency
every-6-hours smtp-config asm_smtp_conf multi-leveled-report { view-by url time-diff last-hour limit 5 chart-path add {
policy violation } }
Creates a scheduled report, starting from the next hour and executing every 6 hours. The report contains a PDF showing
statistics for the top 5 violated URLs after drilling-down to the top policy followed by the top violation. The report is
sent to person@domain.co using the smtp configuration defined in asm_smtp_conf.
list scheduled-report
Displays all of the pool traffic scheduled reports.
OPTIONS
email-addresses
A list of the email addresses of the recipients that receive the scheduled report.
first-time
First scheduled report time. Must be after current time and rounded up to the next round hour.
frequency
The scheduled report frequency. Example: every-6-hours means that the report will be generated and sent every 6 hours.
include-total
Enables or disables including a summary (Overall result) entity in results.
multi-leveled-report
Defines a custom multi-leveled report. Mutually exclusive with predefined-report-name. The multi-leveled-report
definition contains the following parameters:
chart-path
A list of entities that define the scope in which the report will be displayed. For example: a chart path {
violation url } means: Use the top violation list and generate a top URL list from it. These top URLs will be
then used to display the view-by entity. For a list of valid entities see the help manual for analytics pool-
traffic report.
limit
The number of view-by entities displayed in the scheduled report.
time-diff
The time range for the report.
view-by
The main entity that the report is viewed by. For a list of valid entities see the help manual for analytics
pool-traffic report.
measures
The measures which are available for the selected entities.
predefined-report-name
Defines which predefined report (AKA predefined filter) will be used to generate the report. This keyword is
mutually exclusive with multi-leveled-report.
smtp-config
Defines which SMTP configuration will be used to send the scheduled report. If set to none, the scheduled report
will be disabled.
device-group
Defines the device-group which the report should generate the report for. If 'none' is set to this field, then the
report will be generate for the 'self' device.
SEE ALSO
list, modify, show, tmsh, analytics pool-traffic report, sys smtp-server
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 2009-2013, 2015, 2018. All rights reserved.
BIG-IP 2018-10-20 analytics pool-traffic scheduled-report(1)