Citrix ADC 12.1 NITRO API Reference
This content has been machine translated dynamically.
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
dns
August 17, 2023
Contributed by:
C
Statistics for dns.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| clearstats |
|
Read-write | Clear the statsistics / counters. Possible values = basic, full |
| dnstotqueries |
|
Read-only | Total number of DNS queries received. |
| dnsqueriesrate |
|
Read-only | Rate (/s) counter for dnstotqueries |
| dnstotmultiquery |
|
Read-only | Total number of Multi Query request received. |
| dnstotanswers |
|
Read-only | Total number of DNS responses received. |
| dnsanswersrate |
|
Read-only | Rate (/s) counter for dnstotanswers |
| dnstotserverresponse |
|
Read-only | Total number of Server responses received. |
| dnsserverresponserate |
|
Read-only | Rate (/s) counter for dnstotserverresponse |
| dnstotrecupdate |
|
Read-only | Total number of record updates. |
| dnscurcachesize |
|
Read-only | Current DNS cache size |
| dnscurnegcachesize |
|
Read-only | Current Negative DNS cache size |
| dnstotjumboqueries |
|
Read-only | Total number of Jumbo DNS queries received over UDP. |
| dnsjumboqueriesrate |
|
Read-only | Rate (/s) counter for dnstotjumboqueries |
| dnstotjumboanswers |
|
Read-only | Total number of Jumbo DNS responses sent over UDP. |
| dnsjumboanswersrate |
|
Read-only | Rate (/s) counter for dnstotjumboanswers |
| dnstotjumboserverresponses |
|
Read-only | Total number of Jumbo DNS responses received over UDP. |
| dnsjumboserverresponsesrate |
|
Read-only | Rate (/s) counter for dnstotjumboserverresponses |
| dnstotauthans |
|
Read-only | Number of queries which were authoritatively answered. |
| dnstotserverquery |
|
Read-only | Total number of Server queries sent. |
| dnsserverqueryrate |
|
Read-only | Rate (/s) counter for dnstotserverquery |
| dnstotcacheflush |
|
Read-only | Total number of times cache was flushed. |
| dnstotcacheentriesflush |
|
Read-only | Total number of cache entries flushed. |
| dnscurnoauthentries |
|
Read-only | Total number of non-authoritative entries. |
| dnscurauthentries |
|
Read-only | Total number of authoritative entries. |
| dnstotauthnonames |
|
Read-only | Number of queries for which no record was found. |
| dnstotunsupportedresponseclass |
|
Read-only | Total number of responses for which response types were unsupported. |
| dnstotinvalidqueryformat |
|
Read-only | Total number of queries whose format was invalid. |
| dnstotstrayanswer |
|
Read-only | Total number of stray answers. |
| dnstotresponsebadlen |
|
Read-only | Number of DNS responses received with invalid resoure data length. |
| dnstotreqrefusals |
|
Read-only | Number of DNS requests refused. |
| dnserrnullattack |
|
Read-only | Total number of queries received where all the counts are 0. |
| dnstotunsupportedresponsetype |
|
Read-only | Total number of responses for which response type requested was unsupported. |
| dnstotunsupportedqueryclass |
|
Read-only | Total number of queries for which query class was unsupported. |
| dnstotnonauthnodatas |
|
Read-only | Total number of responses for which there was a format error. |
| dnstotnodataresps |
|
Read-only | Number of DNS responses received without answer. |
| dnstotmultiquerydisableerror |
|
Read-only | Total number of times a multi query was disabled and received a multi query. |
| dnstotothererrors |
|
Read-only | Total number of other errors. |
| dns64totqueries |
|
Read-only | Total number of DNS64 queries recieved. |
| dns64queriesrate |
|
Read-only | Rate (/s) counter for dns64totqueries |
| dns64totanswers |
|
Read-only | Total number of DNS64 answers served. |
| dns64answersrate |
|
Read-only | Rate (/s) counter for dns64totanswers |
| dns64totrwanswers |
|
Read-only | Total number of DNS64 answers served after rewriting the response. |
| dns64rwanswersrate |
|
Read-only | Rate (/s) counter for dns64totrwanswers |
| dns64totresponses |
|
Read-only | Total number of responses recieved from backend in DNS64 context. |
| dns64responsesrate |
|
Read-only | Rate (/s) counter for dns64totresponses |
| dns64totgslbqueries |
|
Read-only | Total number of DNS64 queries for GSLB domain |
| dns64gslbqueriesrate |
|
Read-only | Rate (/s) counter for dns64totgslbqueries |
| dns64totgslbanswers |
|
Read-only | Total number of DNS64 queries served. |
| dns64gslbanswersrate |
|
Read-only | Rate (/s) counter for dns64totgslbanswers |
| dns64tottcanswers |
|
Read-only | Total number of Answers served with TC bit set in DNS64 context. |
| dns64tcanswersrate |
|
Read-only | Rate (/s) counter for dns64tottcanswers |
| dns64totsvraqueries |
|
Read-only | Total number of Queries sent by DNS64 module to backend. |
| dns64svraqueriesrate |
|
Read-only | Rate (/s) counter for dns64totsvraqueries |
| dns64totaaaabypass |
|
Read-only | Total number of times AAAA query has been bypassed in DNS64 trnsaction. |
| dns64aaaabypassrate |
|
Read-only | Rate (/s) counter for dns64totaaaabypass |
| dns64tottcpqueries |
|
Read-only | Total number of dns64 queries over TCP |
| dns64tcpqueriesrate |
|
Read-only | Rate (/s) counter for dns64tottcpqueries |
| dns64activepolicies |
|
Read-only | Total number of active dns64 policies |
| dns64totnodataresp |
|
Read-only | Total number of responses recieved from backend with ancount 0 |
| dns64nodataresprate |
|
Read-only | Rate (/s) counter for dns64totnodataresp |
| dnstotnsrecqueries |
|
Read-only | Total number of NS queries received. |
| dnsnsrecqueriesrate |
|
Read-only | Rate (/s) counter for dnstotnsrecqueries |
| dnstotsoarecqueries |
|
Read-only | Total number of SOA queries received. |
| dnssoarecqueriesrate |
|
Read-only | Rate (/s) counter for dnstotsoarecqueries |
| dnstotptrrecqueries |
|
Read-only | Total number of PTR queries received. |
| dnsptrrecqueriesrate |
|
Read-only | Rate (/s) counter for dnstotptrrecqueries |
| dnstotsrvrecqueries |
|
Read-only | Total number of SRV queries received. |
| dnssrvrecqueriesrate |
|
Read-only | Rate (/s) counter for dnstotsrvrecqueries |
| dnstotaresponse |
|
Read-only | Total number of A responses received. |
| dnsaresponserate |
|
Read-only | Rate (/s) counter for dnstotaresponse |
| dnstotcnameresponse |
|
Read-only | Total number of CNAME responses received. |
| dnscnameresponserate |
|
Read-only | Rate (/s) counter for dnstotcnameresponse |
| dnstotmxresponse |
|
Read-only | Total number of MX responses received. |
| dnsmxresponserate |
|
Read-only | Rate (/s) counter for dnstotmxresponse |
| dnstotanyresponse |
|
Read-only | Total number of ANY responses received. |
| dnsanyresponserate |
|
Read-only | Rate (/s) counter for dnstotanyresponse |
| dnstotnsrecupdate |
|
Read-only | Total number of NS record updates. |
| dnstotsoarecupdate |
|
Read-only | Total number of SOA record updates. |
| dnstotptrrecupdate |
|
Read-only | Total number of PTR record updates. |
| dnstotsrvrecupdate |
|
Read-only | Total number of SRV record updates. |
| dnstotaaaarecqueries |
|
Read-only | Total number of AAAA queries received. |
| dnsaaaarecqueriesrate |
|
Read-only | Rate (/s) counter for dnstotaaaarecqueries |
| dnstotarecqueries |
|
Read-only | Total number of A queries received. |
| dnsarecqueriesrate |
|
Read-only | Rate (/s) counter for dnstotarecqueries |
| dnstotcnamerecqueries |
|
Read-only | Total number of CNAME queries received. |
| dnscnamerecqueriesrate |
|
Read-only | Rate (/s) counter for dnstotcnamerecqueries |
| dnstotmxrecqueries |
|
Read-only | Total number of MX queries received. |
| dnsmxrecqueriesrate |
|
Read-only | Rate (/s) counter for dnstotmxrecqueries |
| dnstotanyqueries |
|
Read-only | Total number of ANY queries received. |
| dnsanyqueriesrate |
|
Read-only | Rate (/s) counter for dnstotanyqueries |
| dnstotaaaaresponse |
|
Read-only | Total number of AAAA responses received. |
| dnsaaaaresponserate |
|
Read-only | Rate (/s) counter for dnstotaaaaresponse |
| dnstotnsresponse |
|
Read-only | Total number of NS responses received. |
| dnsnsresponserate |
|
Read-only | Rate (/s) counter for dnstotnsresponse |
| dnstotsoaresponse |
|
Read-only | Total number of SOA responses received. |
| dnssoaresponserate |
|
Read-only | Rate (/s) counter for dnstotsoaresponse |
| dnstotptrresponse |
|
Read-only | Total number of PTR responses received. |
| dnsptrresponserate |
|
Read-only | Rate (/s) counter for dnstotptrresponse |
| dnstotsrvresponse |
|
Read-only | Total number of SRV responses received. |
| dnssrvresponserate |
|
Read-only | Rate (/s) counter for dnstotsrvresponse |
| dnstotaaaarecupdate |
|
Read-only | Total number of AAAA record updates. |
| dnstotarecupdate |
|
Read-only | Total number of A record updates. |
| dnstotmxrecupdate |
|
Read-only | Total number of MX record updates. |
| dnstotcnamerecupdate |
|
Read-only | Total number of CNAME record updates. |
| dnscuraaaarecord |
|
Read-only | Total number of AAAA records. |
| dnscurarecord |
|
Read-only | Total number of A records. |
| dnscurmxrecord |
|
Read-only | Total number of MX records. |
| dnscurcnamerecord |
|
Read-only | Total number of CNAME records. |
| dnscurnsrecord |
|
Read-only | Total number of NS records. |
| dnscursoarecord |
|
Read-only | Total number of SOA records. |
| dnscurptrrecord |
|
Read-only | Total number of PTR records. |
| dnscursrvrecord |
|
Read-only | Total number of SRV records. |
| dnstotaaaarecfailed |
|
Read-only | Total number of times AAAA record lookup failed. |
| dnstotarecfailed |
|
Read-only | Total number of times A record lookup failed. |
| dnstotmxrecfailed |
|
Read-only | Total number of times MX record lookup failed. |
| dnstotptrrecfailed |
|
Read-only | Total number of times PTR record lookup failed. |
| dnstotnsrecfailed |
|
Read-only | Total number of times NS record lookup failed. |
| dnstotcnamerecfailed |
|
Read-only | Total number of times CNAME record lookup failed. |
| dnstotsoarecfailed |
|
Read-only | Total number of times SOA record lookup failed. |
| dnstotsrvrecfailed |
|
Read-only | Total number of times SRV record lookup failed. |
| dnstotanyrecfailed |
|
Read-only | Total number of times ANY query lookup failed. |
| dnstotunsupportedqueries |
|
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 Citrix ADC appliance, the URL is as follows:
http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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>
*Note:*
Mandatory parameters are marked in redand placeholder content is marked in <green>.
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/dns
Query-parameters:
args
http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "dns": [ {
"dnstotcnameresponse":<Double_value>,
"dnstotjumboserverresponses":<Double_value>,
"dnsaresponserate":<Double_value>,
"dns64rwanswersrate":<Double_value>,
"dnstotaaaarecupdate":<Double_value>,
"dnstotptrrecupdate":<Double_value>,
"dns64nodataresprate":<Double_value>,
"dnserrnullattack":<Double_value>,
"dnstotunsupportedqueries":<Double_value>,
"dnstotjumboqueries":<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>,
"dnscurcachesize":<Double_value>,
"dnscurnegcachesize":<Double_value>,
"dnssrvrecqueriesrate":<Double_value>,
"dnsjumboqueriesrate":<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>,
"dnstotjumboanswers":<Double_value>,
"dnstotcacheflush":<Double_value>,
"dnstotarecfailed":<Double_value>,
"dnstotsrvrecupdate":<Double_value>,
"dns64svraqueriesrate":<Double_value>,
"dnsserverqueryrate":<Double_value>,
"dnsjumboanswersrate":<Double_value>,
"dnsjumboserverresponsesrate":<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>
}]}
<!--NeedCopy-->
The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.
DIESER DIENST KANN ÜBERSETZUNGEN ENTHALTEN, DIE VON GOOGLE BEREITGESTELLT WERDEN. GOOGLE LEHNT JEDE AUSDRÜCKLICHE ODER STILLSCHWEIGENDE GEWÄHRLEISTUNG IN BEZUG AUF DIE ÜBERSETZUNGEN AB, EINSCHLIESSLICH JEGLICHER GEWÄHRLEISTUNG DER GENAUIGKEIT, ZUVERLÄSSIGKEIT UND JEGLICHER STILLSCHWEIGENDEN GEWÄHRLEISTUNG DER MARKTGÄNGIGKEIT, DER EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND DER NICHTVERLETZUNG VON RECHTEN DRITTER.
CE SERVICE PEUT CONTENIR DES TRADUCTIONS FOURNIES PAR GOOGLE. GOOGLE EXCLUT TOUTE GARANTIE RELATIVE AUX TRADUCTIONS, EXPRESSE OU IMPLICITE, Y COMPRIS TOUTE GARANTIE D'EXACTITUDE, DE FIABILITÉ ET TOUTE GARANTIE IMPLICITE DE QUALITÉ MARCHANDE, D'ADÉQUATION À UN USAGE PARTICULIER ET D'ABSENCE DE CONTREFAÇON.
ESTE SERVICIO PUEDE CONTENER TRADUCCIONES CON TECNOLOGÍA DE GOOGLE. GOOGLE RENUNCIA A TODAS LAS GARANTÍAS RELACIONADAS CON LAS TRADUCCIONES, TANTO IMPLÍCITAS COMO EXPLÍCITAS, INCLUIDAS LAS GARANTÍAS DE EXACTITUD, FIABILIDAD Y OTRAS GARANTÍAS IMPLÍCITAS DE COMERCIABILIDAD, IDONEIDAD PARA UN FIN EN PARTICULAR Y AUSENCIA DE INFRACCIÓN DE DERECHOS.
本服务可能包含由 Google 提供技术支持的翻译。Google 对这些翻译内容不做任何明示或暗示的保证，包括对准确性、可靠性的任何保证以及对适销性、特定用途的适用性和非侵权性的任何暗示保证。
このサービスには、Google が提供する翻訳が含まれている可能性があります。Google は翻訳について、明示的か黙示的かを問わず、精度と信頼性に関するあらゆる保証、および商品性、特定目的への適合性、第三者の権利を侵害しないことに関するあらゆる黙示的保証を含め、一切保証しません。
ESTE SERVIÇO PODE CONTER TRADUÇÕES FORNECIDAS PELO GOOGLE. O GOOGLE SE EXIME DE TODAS AS GARANTIAS RELACIONADAS COM AS TRADUÇÕES, EXPRESSAS OU IMPLÍCITAS, INCLUINDO QUALQUER GARANTIA DE PRECISÃO, CONFIABILIDADE E QUALQUER GARANTIA IMPLÍCITA DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM PROPÓSITO ESPECÍFICO E NÃO INFRAÇÃO.
Was this helpful
This content has been machine translated dynamically.
August 17, 2023
Contributed by:
C
Share
August 17, 2023
Contributed by:
C
Share
In this article
Was this helpful
Citrix
Preview Documentation
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.
Copied!
Failed!