analytics dns-profile report

analytics dns-profile report(1) 			BIG-IP TMSH Manual			   analytics dns-profile report(1)

NAME
       report - Displays a DNS Profiles analytics report.

MODULE
       analytics dns-profile

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

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

       •    name - name.

       •    vs-name - vs names.

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

EXAMPLES
       show analytics dns-profile report view-by name

       show analytics dns-profile report view-by name drilldown { { entity vs-name values { vs_1 vs_2 } } }

       send-mail analytics dns-profile report view-by name measures { average-responses } limit 20 order-by { { measure average-
       responses 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-a-reqs
		 IPV4 address requests per seconds.

	    average-aaaa-reqs
		 IPV6 address requests per seconds.

	    average-any-reqs
		 Retrieves all the available type for given name per seconds.

	    average-cname-reqs
		 Alias of one name to another: the DNS lookup will continue by retrying the lookup with the new name per seconds.

	    average-dns64fails
		 IPv6 To IPv4 Requests per seconds.

	    average-dns64reqs
		 IPv6 To IPv4 Requests per seconds.

	    average-dns64trans
		 IPv6 To IPv4 Transfers per seconds.

	    average-drops
		 DNS drops per seconds.

	    average-fast-dns-allowed
		 Last action allowed per seconds.

	    average-fast-dns-drops
		 Last action drops per seconds.

	    average-fast-dns-queries
		 Rapid Responses fast queries per seconds.

	    average-fast-dns-resp-ne
		 Last Action no error per seconds.

	    average-fast-dns-resp-nx
		 Last action NX domain per seconds.

	    average-fast-dns-resp-rf
		 Last action refused per seconds.

	    average-fast-dns-resp-tc
		 last action truncated per seconds.

	    average-fast-dns-responses
		 Rapid responses per seconds.

	    average-hdr-aa
		 Authoritative Answers per seconds.

	    average-hdr-ad
		 Authenticated data per seconds.

	    average-hdr-ra
		 Recursion available per seconds.

	    average-hdr-tc
		 Truncated per seconds.

	    average-hints
		 Cache of the DNS servers list per seconds.

	    average-hit-ratio
		 DNS Hit Ratio - Responses / (Responses + Requests) per seconds.

	    average-hw-inspected
		 Inspected per seconds.

	    average-improperly-formatted
		 Hardware handled packets improperly formatted per seconds.

	    average-invalid-authority
		 Invalid Authority per seconds.

	    average-malformed
		 Protocol violations improperly formatted per seconds.

	    average-mx-reqs
		 Maps a domain name to a list of message transfer agents for that domain per seconds.

	    average-naptr-reqs
		 NAPTR is a type of resource record in the DNS per seconds.

	    average-ns-reqs
		 Delegates a DNS zone to use the given authoritative name servers per seconds.

	    average-other-reqs
		 Other Requests per seconds.

	    average-ptr-reqs
		 Pointer records are used to map a network interface (IP) to a host name per seconds.

	    average-queries
		 DNS queries per seconds.

	    average-r-noerror
		 No Error per seconds.

	    average-r-nxdomain
		 Domain per seconds.

	    average-r-refused
		 Query refused per seconds.

	    average-r-servfail
		 Server Failure per seconds.

	    average-rejects
		 rejects per seconds.

	    average-responses
		 DNS responses per seconds.

	    average-soa-reqs
		 Specifies authoritative information about a DNS zone per seconds.

	    average-srv-reqs
		 A Service record is a specification of data in the Domain Name System defining the location per seconds.

	    average-success-queries
		 Query completed successfully per seconds.

	    average-todns
		 DNS todns per seconds.

	    average-txt-reqs
		 Originally for arbitrary human-readable text in a DNS record per seconds.

       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 dns-profile report(1)