ADC NITRO APIs

dnsprofile

August 17, 2023

Contributed by:

Configuration for DNS profile resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
dnsprofilename	<String>	Read-write	Name of the DNS profile. Minimum length = 1 Maximum length = 127
dnsquerylogging	<String>	Read-write	DNS query logging; if enabled, DNS query information such as DNS query id, DNS query flags , DNS domain name and DNS query type will be logged. Default value: DISABLED Possible values = ENABLED, DISABLED
dnsanswerseclogging	<String>	Read-write	DNS answer section; if enabled, answer section in the response will be logged. Default value: DISABLED Possible values = ENABLED, DISABLED
dnsextendedlogging	<String>	Read-write	DNS extended logging; if enabled, authority and additional section in the response will be logged. Default value: DISABLED Possible values = ENABLED, DISABLED
dnserrorlogging	<String>	Read-write	DNS error logging; if enabled, whenever error is encountered in DNS module reason for the error will be logged. Default value: DISABLED Possible values = ENABLED, DISABLED
cacherecords	<String>	Read-write	Cache resource records in the DNS cache. Applies to resource records obtained through proxy configurations only. End resolver and forwarder configurations always cache records in the DNS cache, and you cannot disable this behavior. When you disable record caching, the appliance stops caching server responses. However, cached records are not flushed. The appliance does not serve requests from the cache until record caching is enabled again. Default value: ENABLED Possible values = ENABLED, DISABLED
cachenegativeresponses	<String>	Read-write	Cache negative responses in the DNS cache. When disabled, the appliance stops caching negative responses except referral records. This applies to all configurations - proxy, end resolver, and forwarder. However, cached responses are not flushed. The appliance does not serve negative responses from the cache until this parameter is enabled again. Default value: ENABLED Possible values = ENABLED, DISABLED
dropmultiqueryrequest	<String>	Read-write	Drop the DNS requests containing multiple queries. When enabled, DNS requests containing multiple queries will be dropped. In case of proxy configuration by default the DNS request containing multiple queries is forwarded to the backend and in case of ADNS and Resolver configuration NOCODE error response will be sent to the client. Default value: DISABLED Possible values = ENABLED, DISABLED
cacheecsresponses	<String>	Read-write	Cache DNS responses with EDNS Client Subnet(ECS) option in the DNS cache. When disabled, the appliance stops caching responses with ECS option. This is relevant to proxy configuration. Enabling/disabling support of ECS option when Citrix ADC is authoritative for a GSLB domain is supported using a knob in GSLB vserver. In all other modes, ECS option is ignored. Default value: DISABLED Possible values = ENABLED, DISABLED
referencecount	<Double>	Read-only	Number of entities using this profile.
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties )

ADD
UPDATE
UNSET
DELETE
GET (ALL)
GET
COUNT

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>

*Note:*

Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"dnsprofile":{
<b>      "dnsprofilename":<String_value>,
</b>      "dnsquerylogging":<String_value>,
      "dnsanswerseclogging":<String_value>,
      "dnsextendedlogging":<String_value>,
      "dnserrorlogging":<String_value>,
      "cacherecords":<String_value>,
      "cachenegativeresponses":<String_value>,
      "dropmultiqueryrequest":<String_value>,
      "cacheecsresponses":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"dnsprofile":{
<b>      "dnsprofilename":<String_value>,
</b>      "dnsquerylogging":<String_value>,
      "dnsanswerseclogging":<String_value>,
      "dnsextendedlogging":<String_value>,
      "dnserrorlogging":<String_value>,
      "cacherecords":<String_value>,
      "cachenegativeresponses":<String_value>,
      "dropmultiqueryrequest":<String_value>,
      "cacheecsresponses":<String_value>
}}

<!--NeedCopy-->

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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"dnsprofile":{
<b>      "dnsprofilename":<String_value>,
</b>      "dnsquerylogging":true,
      "dnsanswerseclogging":true,
      "dnsextendedlogging":true,
      "dnserrorlogging":true,
      "cacherecords":true,
      "cachenegativeresponses":true,
      "dropmultiqueryrequest":true,
      "cacheecsresponses":true
}}

<!--NeedCopy-->

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile/ dnsprofilename_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of dnsprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile? view=summary

Use this query-parameter to get the summary output of dnsprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile? pagesize=#no;pageno=#no

Use this query-parameter to get the dnsprofile resources in chunks.

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 Header:

Content-Type:application/json

Response Payload:

{ "dnsprofile": [ {
      "dnsprofilename":<String_value>,
      "dnsquerylogging":<String_value>,
      "dnsanswerseclogging":<String_value>,
      "dnsextendedlogging":<String_value>,
      "dnserrorlogging":<String_value>,
      "cacherecords":<String_value>,
      "cachenegativeresponses":<String_value>,
      "dropmultiqueryrequest":<String_value>,
      "cacheecsresponses":<String_value>,
      "referencecount":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile/ dnsprofilename_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile/ dnsprofilename_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile/ dnsprofilename_value<String> ? view=summary

Use this query-parameter to get the summary output of dnsprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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 Header:

Content-Type:application/json

Response Payload:

{  "dnsprofile": [ {
      "dnsprofilename":<String_value>,
      "dnsquerylogging":<String_value>,
      "dnsanswerseclogging":<String_value>,
      "dnsextendedlogging":<String_value>,
      "dnserrorlogging":<String_value>,
      "cacherecords":<String_value>,
      "cachenegativeresponses":<String_value>,
      "dropmultiqueryrequest":<String_value>,
      "cacheecsresponses":<String_value>,
      "referencecount":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsprofile? count=yes

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 Header:

Content-Type:application/json

Response Payload:

{ "dnsprofile": [ { "__count": "#no"} ] }

<!--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.

Was this helpful

dnsprofile

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

dnsprofile

Properties

Operations

add

update

unset

delete

get (all)

get

count

In this article