Product Documentation

dnsaction

Sep 05, 2016

Configuration for DNS action resource.

Properties (click to see Operations)

Name Data Type Permissions Description
actionname
<String>
Read-write
Name of the dns action.
actiontype
<String>
Read-write
The type of DNS action that is being configured.
Possible values = ViewName, GslbPrefLoc, noop, Drop, Cache_Bypass, Rewrite_Response
ipaddress
<String[]>
Read-write
List of IP address to be returned in case of rewrite_response actiontype. They can be of IPV4 or IPV6 type.
In case of set command We will remove all the IP address previously present in the action and will add new once given in set dns action command.
ttl
<Double>
Read-write
Time to live, in seconds.
Default value: 3600
Minimum value = 0
Maximum value = 2147483647
viewname
<String>
Read-write
The view name that must be used for the given action.
preferredloclist
<String[]>
Read-write
The location list in priority order used for the given action.
Minimum length = 1
dnsprofilename
<String>
Read-write
Name of the DNS profile to be associated with the transaction for which the action is chosen.
Minimum length = 1
Maximum length = 127
drop
<String>
Read-only
The dns packet must be dropped.
Possible values = YES, NO
cachebypass
<String>
Read-only
By pass dns cache for this.
Possible values = YES, NO
builtin
<String[]>
Read-only
Flag to determine whether DNS action is default or not.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
__count
<Double>
Read-only
count parameter

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

add

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"dnsaction":{
      "actionname":<String_value>,
      "actiontype":<String_value>,
      "ipaddress":<String[]_value>,
      "ttl":<Double_value>,
      "viewname":<String_value>,
      "preferredloclist":<String[]_value>,
      "dnsprofilename":<String_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/dnsaction/actionname_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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"dnsaction":{
      "actionname":<String_value>,
      "ipaddress":<String[]_value>,
      "ttl":<Double_value>,
      "viewname":<String_value>,
      "preferredloclist":<String[]_value>,
      "dnsprofilename":<String_value>
}}

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/dnsaction?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"dnsaction":{
      "actionname":<String_value>,
      "ttl":true,
      "dnsprofilename":true
}}

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

Query-parameters:

attrs

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

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

view

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

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

pagination

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

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

Content-Type:application/json

Response Payload:

{ "dnsaction": [ {
      "actionname":<String_value>,
      "actiontype":<String_value>,
      "ttl":<Double_value>,
      "ipaddress":<String[]_value>,
      "viewname":<String_value>,
      "preferredloclist":<String[]_value>,
      "drop":<String_value>,
      "cachebypass":<String_value>,
      "dnsprofilename":<String_value>,
      "builtin":<String[]_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/dnsaction/actionname_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/dnsaction/actionname_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/dnsaction/actionname_value<String>?view=summary

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

Content-Type:application/json

Response Payload:

{ "dnsaction": [ {
      "actionname":<String_value>,
      "actiontype":<String_value>,
      "ttl":<Double_value>,
      "ipaddress":<String[]_value>,
      "viewname":<String_value>,
      "preferredloclist":<String[]_value>,
      "drop":<String_value>,
      "cachebypass":<String_value>,
      "dnsprofilename":<String_value>,
      "builtin":<String[]_value>
}]}

count

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

Content-Type:application/json

Response Payload:

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