dnsaaaarec¶
Configuration for IPv6 address type record resource.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
hostname | <String> | Read-write | Domain name.
Minimum length = 1 |
ipv6address | <String> | Read-write | One or more IPv6 addresses to assign to the domain name.
Minimum length = 1 |
ttl | <Double> | 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 | <String> | Read-write | Subnet for which the cached records need to be removed. |
type | <String> | 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. Possible values = ALL, ADNS, PROXY |
nodeid | <Double> | Read-write | Unique number that identifies the cluster node.
Minimum value = 0 Maximum value = 31 |
vservername | <String> | Read-only | Vitual server name. |
authtype | <String> | Read-only | Authentication type.
Possible values = ALL, ADNS, PROXY |
__count | <Double> | Read-only | count parameter |
Operations¶
(click to see Properties )
- ADD
- DELETE
- GET (ALL)
- 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/dnsaaaarec
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"dnsaaaarec":{
<b> "hostname":<String_value>,
</b><b> "ipv6address":<String_value>,
</b> "ttl":<Double_value>
}}
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/dnsaaaarec/ hostname_value<String>
Query-parameters:
args=ecssubnet: <String_value> ,ipv6address: <String_value>
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/dnsaaaarec
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/config/dnsaaaarec? args=hostname: <String_value> ,ipv6address: <String_value> ,type: <String_value> ,nodeid: <Double_value>
Use this query-parameter to get dnsaaaarec resources based on additional properties.
attrs
http:// <netscaler-ip-address> /nitro/v1/config/dnsaaaarec? 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/dnsaaaarec? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of dnsaaaarec resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http:// <netscaler-ip-address> /nitro/v1/config/dnsaaaarec? view=summary
Use this query-parameter to get the summary output of dnsaaaarec 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/dnsaaaarec? pagesize=#no;pageno=#no
Use this query-parameter to get the dnsaaaarec 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:
{ "dnsaaaarec": [ {
hostname:<String_value>,ipv6address:<String_value>,type:<String_value>,nodeid:<Double_value> "ecssubnet":<String_value>,
"ttl":<Double_value>,
"vservername":<String_value>,
"authtype":<String_value>
}]}
count¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsaaaarec? 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:
{ "dnsaaaarec": [ { "__count": "#no"} ] }