ADC NITRO APIs

dnscnamerec

August 17, 2023

Contributed by:

Configuration for CNAME record resource.

Properties

(click to see Operations )

Name	Permissions	Description
aliasname	Read-write	Alias for the canonical domain name. Minimum length = 1
canonicalname	Read-write	Canonical domain name. Minimum length = 1
ttl	Read-write	Time to Live (TTL), in seconds, for the record. TTL is the time for which the record must be cached by DNS proxies. The specified TTL is applied to all the resource records that are of the same record type and belong to the specified domain name. For example, if you add an address record, with a TTL of 36000, to the domain name example.com, the TTLs of all the address records of example.com are changed to 36000. If the TTL is not specified, the Citrix ADC uses either the DNS zone’s minimum TTL or, if the SOA record is not available on the appliance, the default value of 3600. Default value: 3600 Minimum value = 0 Maximum value = 2147483647
ecssubnet	Read-write	Subnet for which the cached CNAME record need to be removed.
type	Read-write	Type of records to display. Available settings function as follows ADNS - Display all authoritative address records. PROXY - Display all proxy address records. ALL - Display all address records. Default value: ADNS Possible values = ALL, ADNS, PROXY
nodeid	Read-write	Unique number that identifies the cluster node. Minimum value = 0 Maximum value = 31
vservername	Read-only	GSLB Vitual server name to which this domain is bound.
authtype	Read-only	Record type. Possible values = ALL, ADNS, PROXY
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
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/dnscnamerec

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"dnscnamerec":{
<b>      "aliasname":<String_value>,
</b><b>      "canonicalname":<String_value>,
</b>      "ttl":<Double_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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnscnamerec/ aliasname_value<String>

Query-parameters:

args=ecssubnet: <String_value>

</b>

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/dnscnamerec

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/dnscnamerec? args=aliasname: <String_value> ,type: <String_value> ,nodeid: <Double_value>

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

attrs

http:// <netscaler-ip-address> /nitro/v1/config/dnscnamerec? 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/dnscnamerec? filter=property-name1:property-val1,property-name2:property-val2

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

view

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

Use this query-parameter to get the summary output of dnscnamerec 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/dnscnamerec? pagesize=#no;pageno=#no

Use this query-parameter to get the dnscnamerec 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:

{ "dnscnamerec": [ {
aliasname:<String_value>,type:<String_value>,nodeid:<Double_value>      "canonicalname":<String_value>,
      "ttl":<Double_value>,
      "vservername":<String_value>,
      "authtype":<String_value>,
      "ecssubnet":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnscnamerec/ aliasname_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/dnscnamerec/ aliasname_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/dnscnamerec/ aliasname_value<String> ? view=summary

Use this query-parameter to get the summary output of dnscnamerec 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:

{  "dnscnamerec": [ {
aliasname:<String_value>,type:<String_value>,nodeid:<Double_value>      "canonicalname":<String_value>,
      "ttl":<Double_value>,
      "vservername":<String_value>,
      "authtype":<String_value>,
      "ecssubnet":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnscnamerec? 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:

{ "dnscnamerec": [ { "__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

dnscnamerec

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

dnscnamerec

Properties

Operations

add

delete

get (all)

get

count

In this article