analytics ip-intelligence report

analytics ip-intelligence report(1)			BIG-IP TMSH Manual		       analytics ip-intelligence report(1)

NAME
       report - Displays an IP Intelligence analytics report.

MODULE
       analytics ip-intelligence

SYNTAX
       Show, save or send an analytics ip-intelligence report using the syntax shown in the following sections.

   DISPLAY
	show report view-by [ actions | class-name | context-name | context-type | hit-type | policy | protocol | source-ip | vlan ]
	 options:
	  drilldown {
	    {
		entity [ actions | class-name | context-name | context-type | hit-type | policy | protocol | source-ip | vlan ]
		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 [ actions | class-name | context-name | context-type | hit-type | policy | protocol | source-ip | vlan ]
	 options:
	   drilldown {
	    {
		entity [ actions | class-name | context-name | context-type | hit-type | policy | protocol | source-ip | vlan ]
		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 [ actions | class-name | context-name | context-type | hit-type | policy | protocol | source-ip | vlan ]
	 options:
	  drilldown {
	    {
		entity [ actions | class-name | context-name | context-type | hit-type | policy | protocol | source-ip | vlan ]
		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 Intelligence analytics reports. You can generate an IP Intelligence analytics report for
       the following entities:

       •    actions - Actions (dropped / allowed).

       •    class-name - Class-Name for the hit.

       •    context-name - Context Name (VS name, RouteDomain name etc...).

       •    context-type - Context Type (Virtual, RouteDomain or Global).

       •    hit-type - Hit Type (BlackList Hit or BlackList+WhiteList Hit).

       •    policy - Policy Name (Name of the DWBL policy which was hit).

       •    protocol - Standard IP protocol (tcp, udp, etc...).

       •    source-ip - Source IPs of hits.

       •    vlan - Vlan.

       Different measures are collected for each of these entities and can be a part of the report request.

EXAMPLES
       show analytics ip-intelligence report view-by actions

       show analytics ip-intelligence report view-by actions drilldown { { entity vlan values { vlan_1 vlan_2 } } }

       send-mail analytics ip-intelligence report view-by actions measures { request-count } limit 20 order-by { { measure
       request-count 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:

	    count-class
		 The total number of events for Dynamic White/Black List with respect to the Class-Names.

	    request-count
		 The total number of events for Dynamic White/Black List.

       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-05			       analytics ip-intelligence report(1)