analytics fw-nat report

analytics fw-nat report(1)    BIG-IP TMSH Manual    analytics fw-nat report(1)



NAME
       report - Displays a firewall NAT analytics report.

MODULE
       analytics fw-nat

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

   DISPLAY
	show report view-by [ name | lsn-pool ]
	 options:
	  drilldown {
	    {
		entity [ name | lsn-pool ]
		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 [ name | lsn-pool ]
	 options:
	   drilldown {
	    {
		entity [ name | lsn-pool ]
		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 [ name | lsn-pool ]
	 options:
	  drilldown {
	    {
		entity [ name | lsn-pool ]
		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 firewall NAT analytics reports. You can
       generate a firewall NAT analytics report for the following entities:

       o    name - Name.

       o    lsn_pool - LSN pool name.

EXAMPLES
       show analytics fw-nat report view-by name

       show analytics fw-nat report view-by name drilldown { { entity name
       values { my_name } } }

       send-mail analytics fw-nat report view-by name limit 20 format pdf
       email-addresses { some.one@someaddress.com }

       For more syntactical examples see 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. This option
	    must be used with the drilldown option. You can also use it along
	    with include-others.

       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-source-translation-requests
		 The average number of FW NAT source translation requests for
		 the selected filter (entity).

	    avg-source-translation-request-failures
		 The average number of FW NAT source translation request
		 failures for the selected filter (entity).

	    avg-destination-translation-requests
		 The average number of FW NAT destination translation requests
		 for the selected filter (entity).

	    avg-destination-translation-request-failures
		 The average number of FW NAT destination translation request
		 failures for the selected filter (entity).

	    avg-active-translations
		 The average number of FW NAT active translations for the
		 selected filter (entity).

	    avg-backup-pool-translations
		 The average number of FW NAT backup-pool translations for the
		 selected filter (entity).

	    avg-log-attempts
		 The average number of FW NAT log attempts for the selected
		 filter (entity). Only applies to FW NATs in logging mode.

	    avg-log-failures
		 The average number of FW NAT log failures for the selected
		 filter (entity). Only applies to FW NATs in logging mode.

	    avg-active-port-blocks
		 The average number of FW NAT active port-blocks for the
		 selected filter (entity). Only applies to FW NATs in PBA
		 mode.

	    avg-port-block-allocations
		 The average number of FW NAT port-block allocations for the
		 selected filter (entity). Only applies to FW NATs in PBA
		 mode.

	    avg-port-block-deallocations
		 The average number of FW NAT port-block de-allocations for
		 the selected filter (entity). Only applies to FW NATs in PBA
		 mode.

	    avg-zombie-port-blocks-created
		 The average number of FW NAT zombie port-blocks which have
		 been created for the selected filter (entity). Only applies
		 to FW NATs in PBA mode.

	    avg-zombie-port-blocks-deleted
		 The average number of FW NAT zombie port-blocks which have
		 been deleted for the selected filter (entity). Only applies
		 to FW NATs in PBA mode.

	    avg-active-clients-reached-limit
		 The average number of FW NAT active-clients limit reached for
		 the selected filter (entity). Only applies to FW NATs in PBA
		 mode.

	    avg-clients-reached-limit
		 The average number of FW NAT total-clients limit reached for
		 the selected filter (entity). Only applies to FW NATs in PBA
		 mode.

	    avg-pcp-request
		 The average number of FW NAT PCP-requests for the selected
		 filter (entity). Only applies to FW NATs in PCP mode.

	    avg-pcp-response
		 The average number of FW NAT PCP-responses for the selected
		 filter (entity). Only applies to FW NATs in PCP mode.

	    avg-pcp-error
		 The average number of FW NAT PCP-errors for the selected
		 filter (entity). Only applies to FW NATs in PCP mode.

       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, 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, 2018. All rights
       reserved.



BIG-IP				  2018-07-16	    analytics fw-nat report(1)