analytics traffic-classification report

analytics traffic-classification report(1)	  BIG-IP TMSH Manual	   analytics traffic-classification report(1)

NAME
       report - Displays a Traffic Classification analytics report.

MODULE
       analytics traffic-classification

SYNTAX
       Show, save or send a analytics traffic-classification report using the syntax shown in the following sections.

   DISPLAY
	show report view-by [ action-name | application | application-category | destination-country | destination-ip | destination-port |
			       profiles | risk | source-country | source-ip | url-category | user-name |
			       virtual ]
	 options:
	  drilldown {
	    {
		entity [ action-name | application | application-category | destination-country | destination-ip | destination-port |
			       profiles | risk | source-country | source-ip | url-category | user-name |
			       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 [ action-name | application | application-category | destination-country | destination-ip | destination-port |
			       profiles | risk | source-country | source-ip | url-category | user-name |
			       virtual ]
	 options:
	   drilldown {
	    {
		entity [ action-name | application | application-category | destination-country | destination-ip | destination-port |
			       profiles | risk | source-country | source-ip | url-category | user-name |
			       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 [ action-name | application | application-category | destination-country | destination-ip | destination-port |
			       profiles | risk | source-country | source-ip | url-category | user-name |
			       virtual ]
	 options:
	  drilldown {
	    {
		entity [ action-name | application | application-category | destination-country | destination-ip | destination-port |
			       profiles | risk | source-country | source-ip | url-category | user-name |
			       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 Traffic Classification analytics reports. You can generate a Traffic
       Classification analytics report for the following entities:

       ·    action-name - Actions Name.

       ·    application - Classification application Name.

       ·    application-category - Application classification category.

       ·    destination-country - Destination countries.

       ·    destination-ip - A single destination identified by an IP address.

       ·    destination-port - Destination ports.

       ·    profiles - Classification profile.

       ·    risk - Risk.

       ·    source-country - Country from which the traffic originated.

       ·    source-ip - A single source identified by an IP address.

       ·    url-category - URL category.

       ·    user-name - Users name.

       ·    virtual - Virtual servers.

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

EXAMPLES
       show analytics traffic-classification report view-by action-name

       show analytics traffic-classification report view-by action-name drilldown { { entity application values {
       application_name } } }

       send-mail analytics traffic-classification report view-by action-name measures { total-bytes-in } limit 20
       order-by { { measure total-bytes-in 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:

	    average-throughput
		 Total average throughput.

	    average-throughput-in
		 Average incoming throughput.

	    average-throughput-out
		 Average outgoing throughput.

	    flows
		 Total number of classified flows.

	    total-bytes
		 Total bytes in both incoming and outgoing traffic.

	    total-bytes-in
		 Byte counter of incoming (uplink) traffic.

	    total-bytes-out
		 Byte counter of outgoing (downlink) traffic.

       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 traffic-classification report(1)