Product Documentation

dns

Sep 08, 2016

Statistics for dns.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
dnstotqueries
<Double>
Read-only
Total number of DNS queries received.
dnsqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotqueries
dnstotmultiquery
<Double>
Read-only
Total number of Multi Query request received.
dnstotanswers
<Double>
Read-only
Total number of DNS responses received.
dnsanswersrate
<Double>
Read-only
Rate (/s) counter for dnstotanswers
dnstotserverresponse
<Double>
Read-only
Total number of Server responses received.
dnsserverresponserate
<Double>
Read-only
Rate (/s) counter for dnstotserverresponse
dnstotrecupdate
<Double>
Read-only
Total number of record updates.
dnstotauthans
<Double>
Read-only
Number of queries which were authoritatively answered.
dnstotserverquery
<Double>
Read-only
Total number of Server queries sent.
dnsserverqueryrate
<Double>
Read-only
Rate (/s) counter for dnstotserverquery
dnstotcacheflush
<Double>
Read-only
Total number of times cache was flushed.
dnstotcacheentriesflush
<Double>
Read-only
Total number of cache entries flushed.
dnscurnoauthentries
<Double>
Read-only
Total number of non-authoritative entries.
dnscurauthentries
<Double>
Read-only
Total number of authoritative entries.
dnstotauthnonames
<Double>
Read-only
Number of queries for which no record was found.
dnstotunsupportedresponseclass
<Double>
Read-only
Total number of responses for which response types were unsupported.
dnstotinvalidqueryformat
<Double>
Read-only
Total number of queries whose format was invalid.
dnstotstrayanswer
<Double>
Read-only
Total number of stray answers.
dnstotresponsebadlen
<Double>
Read-only
Number of DNS responses received with invalid resoure data length.
dnstotreqrefusals
<Double>
Read-only
Number of DNS requests refused.
dnserrnullattack
<Double>
Read-only
Total number of queries received where all the counts are 0.
dnstotunsupportedresponsetype
<Double>
Read-only
Total number of responses for which response type requested was unsupported.
dnstotunsupportedqueryclass
<Double>
Read-only
Total number of queries for which query class was unsupported.
dnstotnonauthnodatas
<Double>
Read-only
Total number of responses for which there was a format error.
dnstotnodataresps
<Double>
Read-only
Number of DNS responses received without answer.
dnstotmultiquerydisableerror
<Double>
Read-only
Total number of times a multi query was disabled and received a multi query.
dnstotothererrors
<Double>
Read-only
Total number of other errors.
dns64totqueries
<Double>
Read-only
Total number of DNS64 queries recieved.
dns64queriesrate
<Double>
Read-only
Rate (/s) counter for dns64totqueries
dns64totanswers
<Double>
Read-only
Total number of DNS64 answers served.
dns64answersrate
<Double>
Read-only
Rate (/s) counter for dns64totanswers
dns64totrwanswers
<Double>
Read-only
Total number of DNS64 answers served after rewriting the response.
dns64rwanswersrate
<Double>
Read-only
Rate (/s) counter for dns64totrwanswers
dns64totresponses
<Double>
Read-only
Total number of responses recieved from backend in DNS64 context.
dns64responsesrate
<Double>
Read-only
Rate (/s) counter for dns64totresponses
dns64totgslbqueries
<Double>
Read-only
Total number of DNS64 queries for GSLB domain
dns64gslbqueriesrate
<Double>
Read-only
Rate (/s) counter for dns64totgslbqueries
dns64totgslbanswers
<Double>
Read-only
Total number of DNS64 queries served.
dns64gslbanswersrate
<Double>
Read-only
Rate (/s) counter for dns64totgslbanswers
dns64tottcanswers
<Double>
Read-only
Total number of Answers served with TC bit set in DNS64 context.
dns64tcanswersrate
<Double>
Read-only
Rate (/s) counter for dns64tottcanswers
dns64totsvraqueries
<Double>
Read-only
Total number of Queries sent by DNS64 module to backend.
dns64svraqueriesrate
<Double>
Read-only
Rate (/s) counter for dns64totsvraqueries
dns64totaaaabypass
<Double>
Read-only
Total number of times AAAA query has been bypassed in DNS64 trnsaction.
dns64aaaabypassrate
<Double>
Read-only
Rate (/s) counter for dns64totaaaabypass
dns64tottcpqueries
<Double>
Read-only
Total number of dns64 queries over TCP
dns64tcpqueriesrate
<Double>
Read-only
Rate (/s) counter for dns64tottcpqueries
dns64activepolicies
<Double>
Read-only
Total number of active dns64 policies
dns64totnodataresp
<Double>
Read-only
Total number of responses recieved from backend with ancount 0
dns64nodataresprate
<Double>
Read-only
Rate (/s) counter for dns64totnodataresp
dnstotnsrecqueries
<Double>
Read-only
Total number of NS queries received.
dnsnsrecqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotnsrecqueries
dnstotsoarecqueries
<Double>
Read-only
Total number of SOA queries received.
dnssoarecqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotsoarecqueries
dnstotptrrecqueries
<Double>
Read-only
Total number of PTR queries received.
dnsptrrecqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotptrrecqueries
dnstotsrvrecqueries
<Double>
Read-only
Total number of SRV queries received.
dnssrvrecqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotsrvrecqueries
dnstotaresponse
<Double>
Read-only
Total number of A responses received.
dnsaresponserate
<Double>
Read-only
Rate (/s) counter for dnstotaresponse
dnstotcnameresponse
<Double>
Read-only
Total number of CNAME responses received.
dnscnameresponserate
<Double>
Read-only
Rate (/s) counter for dnstotcnameresponse
dnstotmxresponse
<Double>
Read-only
Total number of MX responses received.
dnsmxresponserate
<Double>
Read-only
Rate (/s) counter for dnstotmxresponse
dnstotanyresponse
<Double>
Read-only
Total number of ANY responses received.
dnsanyresponserate
<Double>
Read-only
Rate (/s) counter for dnstotanyresponse
dnstotnsrecupdate
<Double>
Read-only
Total number of NS record updates.
dnstotsoarecupdate
<Double>
Read-only
Total number of SOA record updates.
dnstotptrrecupdate
<Double>
Read-only
Total number of PTR record updates.
dnstotsrvrecupdate
<Double>
Read-only
Total number of SRV record updates.
dnstotaaaarecqueries
<Double>
Read-only
Total number of AAAA queries received.
dnsaaaarecqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotaaaarecqueries
dnstotarecqueries
<Double>
Read-only
Total number of A queries received.
dnsarecqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotarecqueries
dnstotcnamerecqueries
<Double>
Read-only
Total number of CNAME queries received.
dnscnamerecqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotcnamerecqueries
dnstotmxrecqueries
<Double>
Read-only
Total number of MX queries received.
dnsmxrecqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotmxrecqueries
dnstotanyqueries
<Double>
Read-only
Total number of ANY queries received.
dnsanyqueriesrate
<Double>
Read-only
Rate (/s) counter for dnstotanyqueries
dnstotaaaaresponse
<Double>
Read-only
Total number of AAAA responses received.
dnsaaaaresponserate
<Double>
Read-only
Rate (/s) counter for dnstotaaaaresponse
dnstotnsresponse
<Double>
Read-only
Total number of NS responses received.
dnsnsresponserate
<Double>
Read-only
Rate (/s) counter for dnstotnsresponse
dnstotsoaresponse
<Double>
Read-only
Total number of SOA responses received.
dnssoaresponserate
<Double>
Read-only
Rate (/s) counter for dnstotsoaresponse
dnstotptrresponse
<Double>
Read-only
Total number of PTR responses received.
dnsptrresponserate
<Double>
Read-only
Rate (/s) counter for dnstotptrresponse
dnstotsrvresponse
<Double>
Read-only
Total number of SRV responses received.
dnssrvresponserate
<Double>
Read-only
Rate (/s) counter for dnstotsrvresponse
dnstotaaaarecupdate
<Double>
Read-only
Total number of AAAA record updates.
dnstotarecupdate
<Double>
Read-only
Total number of A record updates.
dnstotmxrecupdate
<Double>
Read-only
Total number of MX record updates.
dnstotcnamerecupdate
<Double>
Read-only
Total number of CNAME record updates.
dnscuraaaarecord
<Double>
Read-only
Total number of AAAA records.
dnscurarecord
<Double>
Read-only
Total number of A records.
dnscurmxrecord
<Double>
Read-only
Total number of MX records.
dnscurcnamerecord
<Double>
Read-only
Total number of CNAME records.
dnscurnsrecord
<Double>
Read-only
Total number of NS records.
dnscursoarecord
<Double>
Read-only
Total number of SOA records.
dnscurptrrecord
<Double>
Read-only
Total number of PTR records.
dnscursrvrecord
<Double>
Read-only
Total number of SRV records.
dnstotaaaarecfailed
<Double>
Read-only
Total number of times AAAA record lookup failed.
dnstotarecfailed
<Double>
Read-only
Total number of times A record lookup failed.
dnstotmxrecfailed
<Double>
Read-only
Total number of times MX record lookup failed.
dnstotptrrecfailed
<Double>
Read-only
Total number of times PTR record lookup failed.
dnstotnsrecfailed
<Double>
Read-only
Total number of times NS record lookup failed.
dnstotcnamerecfailed
<Double>
Read-only
Total number of times CNAME record lookup failed.
dnstotsoarecfailed
<Double>
Read-only
Total number of times SOA record lookup failed.
dnstotsrvrecfailed
<Double>
Read-only
Total number of times SRV record lookup failed.
dnstotanyrecfailed
<Double>
Read-only
Total number of times ANY query lookup failed.
dnstotunsupportedqueries
<Double>
Read-only
Total number of requests for which query type requested was unsupported.

Operations (click to see Properties)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/stat/dns

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/dns?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get dns resources based on additional properties.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "dns": [ {
      "dnstotcnameresponse":<Double_value>,
      "dnsaresponserate":<Double_value>,
      "dns64rwanswersrate":<Double_value>,
      "dnstotaaaarecupdate":<Double_value>,
      "dnstotptrrecupdate":<Double_value>,
      "dns64nodataresprate":<Double_value>,
      "dnserrnullattack":<Double_value>,
      "dnstotunsupportedqueries":<Double_value>,
      "dnstotauthnonames":<Double_value>,
      "dnstotmxrecupdate":<Double_value>,
      "dnstotanyqueries":<Double_value>,
      "dns64totrwanswers":<Double_value>,
      "dnstotstrayanswer":<Double_value>,
      "dnstotptrrecfailed":<Double_value>,
      "dns64activepolicies":<Double_value>,
      "dnstotcnamerecupdate":<Double_value>,
      "dnscursoarecord":<Double_value>,
      "dnstotcacheentriesflush":<Double_value>,
      "dnsaaaaresponserate":<Double_value>,
      "dnsaaaarecqueriesrate":<Double_value>,
      "dnstotmxrecqueries":<Double_value>,
      "dnstotsoarecqueries":<Double_value>,
      "dnscurarecord":<Double_value>,
      "dnstotinvalidqueryformat":<Double_value>,
      "dnstotsrvrecfailed":<Double_value>,
      "dnsarecqueriesrate":<Double_value>,
      "dnstotsoaresponse":<Double_value>,
      "dnstotserverresponse":<Double_value>,
      "dnsanyqueriesrate":<Double_value>,
      "dnscurauthentries":<Double_value>,
      "dnstotmxresponse":<Double_value>,
      "dnstotptrrecqueries":<Double_value>,
      "dnstotunsupportedqueryclass":<Double_value>,
      "dnsptrresponserate":<Double_value>,
      "dnssoarecqueriesrate":<Double_value>,
      "dns64totgslbanswers":<Double_value>,
      "dns64answersrate":<Double_value>,
      "dns64totqueries":<Double_value>,
      "dnsptrrecqueriesrate":<Double_value>,
      "dnstotsoarecfailed":<Double_value>,
      "dns64tottcpqueries":<Double_value>,
      "dnstotaaaarecqueries":<Double_value>,
      "dns64responsesrate":<Double_value>,
      "dnstotmxrecfailed":<Double_value>,
      "dns64tottcanswers":<Double_value>,
      "dnstotaaaarecfailed":<Double_value>,
      "dnssrvresponserate":<Double_value>,
      "dnsnsrecqueriesrate":<Double_value>,
      "dnstotserverquery":<Double_value>,
      "dnssoaresponserate":<Double_value>,
      "dnstotmultiquery":<Double_value>,
      "dnscuraaaarecord":<Double_value>,
      "dnsqueriesrate":<Double_value>,
      "dns64gslbqueriesrate":<Double_value>,
      "dnsanyresponserate":<Double_value>,
      "dnsanswersrate":<Double_value>,
      "dnstotarecupdate":<Double_value>,
      "dnscnameresponserate":<Double_value>,
      "dnstotothererrors":<Double_value>,
      "dnstotnsrecfailed":<Double_value>,
      "dnscurcnamerecord":<Double_value>,
      "dnscurnoauthentries":<Double_value>,
      "dnstotresponsebadlen":<Double_value>,
      "dns64totaaaabypass":<Double_value>,
      "dns64tcpqueriesrate":<Double_value>,
      "dnstotaaaaresponse":<Double_value>,
      "dns64gslbanswersrate":<Double_value>,
      "dnstotunsupportedresponsetype":<Double_value>,
      "dns64totsvraqueries":<Double_value>,
      "dns64totresponses":<Double_value>,
      "dnstotnsrecqueries":<Double_value>,
      "dns64totanswers":<Double_value>,
      "dnscursrvrecord":<Double_value>,
      "dnscurptrrecord":<Double_value>,
      "dnstotanyresponse":<Double_value>,
      "dnstotanyrecfailed":<Double_value>,
      "dns64aaaabypassrate":<Double_value>,
      "dnstotnsresponse":<Double_value>,
      "dnssrvrecqueriesrate":<Double_value>,
      "dnstotnsrecupdate":<Double_value>,
      "dnstotcnamerecqueries":<Double_value>,
      "dnstotmultiquerydisableerror":<Double_value>,
      "dnstotarecqueries":<Double_value>,
      "dnsserverresponserate":<Double_value>,
      "dnsnsresponserate":<Double_value>,
      "dnstotanswers":<Double_value>,
      "dnsmxrecqueriesrate":<Double_value>,
      "dnstotcnamerecfailed":<Double_value>,
      "dnstotsrvrecqueries":<Double_value>,
      "dnstotaresponse":<Double_value>,
      "dnscnamerecqueriesrate":<Double_value>,
      "dns64totnodataresp":<Double_value>,
      "dnstotqueries":<Double_value>,
      "dnstotsrvresponse":<Double_value>,
      "dnstotunsupportedresponseclass":<Double_value>,
      "dnstotcacheflush":<Double_value>,
      "dnstotarecfailed":<Double_value>,
      "dnstotsrvrecupdate":<Double_value>,
      "dns64svraqueriesrate":<Double_value>,
      "dnsserverqueryrate":<Double_value>,
      "dnscurnsrecord":<Double_value>,
      "dnstotsoarecupdate":<Double_value>,
      "dns64queriesrate":<Double_value>,
      "dnstotnonauthnodatas":<Double_value>,
      "dnstotauthans":<Double_value>,
      "dnstotreqrefusals":<Double_value>,
      "dnscurmxrecord":<Double_value>,
      "dns64tcanswersrate":<Double_value>,
      "dnstotrecupdate":<Double_value>,
      "dns64totgslbqueries":<Double_value>,
      "dnstotnodataresps":<Double_value>,
      "dnstotptrresponse":<Double_value>,
      "dnsmxresponserate":<Double_value>
}]}