Product Documentation

dnspolicy

Sep 05, 2016

Configuration for DNS policy resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the DNS policy.
rule
<String>
Read-write
Expression against which DNS traffic is evaluated. Written in the default syntax.
Note:
* On the command line interface, if the expression includes blank spaces, the entire expression must be enclosed in double quotation marks.
* If the expression itself includes double quotation marks, you must escape the quotations by using the character.
* Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.
Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: '"<string of 255 characters>" + "<string of 245 characters>"'
Example: CLIENT.UDP.DNS.DOMAIN.EQ("domainname").
viewname
<String>
Read-write
The view name that must be used for the given policy.
preferredlocation
<String>
Read-write
The location used for the given policy. This is deprecated attribute. Please use -prefLocList.
preferredloclist
<String[]>
Read-write
The location list in priority order used for the given policy.
Minimum length = 1
drop
<String>
Read-write
The dns packet must be dropped.
Possible values = YES, NO
cachebypass
<String>
Read-write
By pass dns cache for this.
Possible values = YES, NO
actionname
<String>
Read-write
Name of the DNS action to perform when the rule evaluates to TRUE. The built in actions function as follows:
* dns_default_act_Drop. Drop the DNS request.
* dns_default_act_Cachebypass. Bypass the DNS cache and forward the request to the name server.
You can create custom actions by using the add dns action command in the CLI or the DNS > Actions > Create DNS Action dialog box in the NetScaler configuration utility.
logaction
<String>
Read-write
Name of the messagelog action to use for requests that match this policy.
hits
<Double>
Read-only
The number of times the policy has been hit.
undefhits
<Double>
Read-only
Number of Undef hits.
description
<String>
Read-only
Description of the policy.
builtin
<String[]>
Read-only
Flag to determine whether DNS policy 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/dnspolicy

HTTP Method: POST

Request Headers:

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

Request Payload:

{"dnspolicy":{
      "name":<String_value>,
      "rule":<String_value>,
      "viewname":<String_value>,
      "preferredlocation":<String_value>,
      "preferredloclist":<String[]_value>,
      "drop":<String_value>,
      "cachebypass":<String_value>,
      "actionname":<String_value>,
      "logaction":<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/dnspolicy/name_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/dnspolicy

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"dnspolicy":{
      "name":<String_value>,
      "rule":<String_value>,
      "viewname":<String_value>,
      "preferredlocation":<String_value>,
      "preferredloclist":<String[]_value>,
      "drop":<String_value>,
      "cachebypass":<String_value>,
      "actionname":<String_value>,
      "logaction":<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/dnspolicy?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"dnspolicy":{
      "name":<String_value>,
      "logaction":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/dnspolicy

Query-parameters:

attrs

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

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

view

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

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

pagination

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

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

{ "dnspolicy": [ {
      "name":<String_value>,
      "rule":<String_value>,
      "viewname":<String_value>,
      "preferredlocation":<String_value>,
      "preferredloclist":<String[]_value>,
      "hits":<Double_value>,
      "undefhits":<Double_value>,
      "drop":<String_value>,
      "actionname":<String_value>,
      "cachebypass":<String_value>,
      "description":<String_value>,
      "logaction":<String_value>,
      "builtin":<String[]_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/dnspolicy/name_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/dnspolicy/name_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/dnspolicy/name_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:

{ "dnspolicy": [ {
      "name":<String_value>,
      "rule":<String_value>,
      "viewname":<String_value>,
      "preferredlocation":<String_value>,
      "preferredloclist":<String[]_value>,
      "hits":<Double_value>,
      "undefhits":<Double_value>,
      "drop":<String_value>,
      "actionname":<String_value>,
      "cachebypass":<String_value>,
      "description":<String_value>,
      "logaction":<String_value>,
      "builtin":<String[]_value>
}]}

count

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

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