analytics lsn-pool report

analytics lsn-pool report(1)			  BIG-IP TMSH Manual			 analytics lsn-pool report(1)

NAME
       report - Displays an LSN Pool analytics report.

MODULE
       analytics lsn-pool

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

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

       ·    lsn-pool - LSN Pool translation statistics

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

EXAMPLES
       show analytics lsn-pool report view-by lsn-pool

       send-mail analytics lsn-pool report view-by lsn-pool measures { active-translations } limit 20 order-by { {
       measure active-translations 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:

	    active-translations
		 The average number of active LSN translations for the selected filter (entity).

	    translation-request
		 The total number of LSN translation requests for the selected filter (entity).

	    translation-failure
		 The total number of failed LSN translations for the selected filter (entity).

	    translation-from-backup
		 The total number of LSN translations using the backup pool for selected filter (entity). Only
		 applies to LSN Pool in Deterministic NAT mode.

	    active-pb
		 The average number of active port-blocks for the selected filter (entity). Only applies to LSN Pool
		 in PBA mode.

	    pb-allocations
		 The total number of port-block allocations for the selected filter (entity). Only applies to LSN
		 Pool in PBA mode.

	    pb-freed
		 The total number of port-block deallocations for the selected filter (entity). Only applies to LSN
		 Pool in PBA mode.

	    zombie-block-created
		 The total number of zombie blocks created for the selected filter (entity). Only applies to LSN Pool
		 in PBA mode.

	    zombie-block-deleted
		 The total number of zombie blocks deleted for the selected filter (entity). Only applies to LSN Pool
		 in PBA mode.

	    active-pb-clients-reached-limit
		 The average number of port-block clients that have reached the port-block limit for the selected
		 filter (entity). Only applies to LSN Pool in PBA mode.

	    pb-client-reached-limit
		 The total number of port-block clients that have reached the port-block limit for the selected
		 filter (entity). Only applies to LSN Pool in PBA mode.

	    pcp-requests
		 The total number of PCP requests for the selected filter (entity). Only applies to LSN Pool with PCP
		 profile.

	    pcp-responses
		 The total number of PCP responses for the selected filter (entity). Only applies to LSN Pool with
		 PCP profile.

	    pcp-errors
		 The total number of PCP errors for the selected filter (entity). Only applies to LSN Pool with PCP
		 profile.

	    log-attempts
		 The total number of logging attempts for the selected filter (entity). Only applies to LSN Pool with
		 Log publisher attached.

	    log-failures
		 The total number of logging failures for the selected filter (entity). Only applies to LSN Pool with
		 Log publisher attached.

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

BIG-IP						      2016-03-14			 analytics lsn-pool report(1)