dnspolicylabel
Configuration for dns policy label resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| labelname | <String> | Read-write | Name of the dns policy label. |
| transform | <String> | Read-write | The type of transformations allowed by the policies bound to the label.<br>Possible values = dns_req, dns_res |
| newname | <String> | Read-write | The new name of the dns policylabel.<br>Minimum length = 1 |
| numpol | <Double> | Read-only | Number of polices bound to label. |
| hits | <Double> | Read-only | Number of times policy label was invoked. |
| priority | <Double> | Read-only | Specifies the priority of the policy. |
| gotopriorityexpression | <String> | Read-only | Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE. |
| labeltype | <String> | Read-only | Type of policy label invocation.<br>Possible values = policylabel |
| invoke_labelname | <String> | Read-only | Name of the label to invoke if the current policy rule evaluates to TRUE. |
| flowtype | <Double> | Read-only | Flowtype of the bound dns policy. |
| description | <String> | Read-only | Description of the policylabel. |
| isdefault | <Boolean> | Read-only | A value of true is returned if it is a default dns policylabel. |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties)
ADD | DELETE | RENAME | 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/dnspolicylabel
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"dnspolicylabel":{
"labelname":<String_value>,
"transform":<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/dnspolicylabel/labelname_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
rename
URL: http://<netscaler-ip-address>/nitro/v1/config/dnspolicylabel?action=rename
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"dnspolicylabel":{
"labelname":<String_value>,
"newname":<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
get (all)
URL: http://<netscaler-ip-address>/nitro/v1/config/dnspolicylabel
Query-parameters:
attrs
http://<netscaler-ip-address>/nitro/v1/config/dnspolicylabel?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/dnspolicylabel?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of dnspolicylabel resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http://<netscaler-ip-address>/nitro/v1/config/dnspolicylabel?view=summary
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination
http://<netscaler-ip-address>/nitro/v1/config/dnspolicylabel?pagesize=#no;pageno=#no
Use this query-parameter to get the dnspolicylabel 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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "dnspolicylabel": [ {
"labelname":<String_value>,
"transform":<String_value>,
"numpol":<Double_value>,
"hits":<Double_value>,
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"labeltype":<String_value>,
"invoke_labelname":<String_value>,
"flowtype":<Double_value>,
"description":<String_value>,
"isdefault":<Boolean_value>
}]}
get
URL: http://<netscaler-ip-address>/nitro/v1/config/dnspolicylabel/labelname_value<String>
Query-parameters:
attrs
http://<netscaler-ip-address>/nitro/v1/config/dnspolicylabel/labelname_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/dnspolicylabel/labelname_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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "dnspolicylabel": [ {
"labelname":<String_value>,
"transform":<String_value>,
"numpol":<Double_value>,
"hits":<Double_value>,
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"labeltype":<String_value>,
"invoke_labelname":<String_value>,
"flowtype":<Double_value>,
"description":<String_value>,
"isdefault":<Boolean_value>
}]}
count
URL: http://<netscaler-ip-address>/nitro/v1/config/dnspolicylabel?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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "dnspolicylabel": [ { "__count": "#no"} ] }