Download full document:

dnssrvrec

Configuration for server record resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
domain	<String>	Read-write	Domain name, which, by convention, is prefixed by the symbolic name of the desired service and the symbolic name of the desired protocol, each with an underscore (_) prepended. For example, if an SRV-aware client wants to discover a SIP service that is provided over UDP, in the domain example.com, the client performs a lookup for _sip._udp.example.com.<br>Minimum length = 1
target	<String>	Read-write	Target host for the specified service.
priority	<Double>	Read-write	Integer specifying the priority of the target host. The lower the number, the higher the priority. If multiple target hosts have the same priority, selection is based on the Weight parameter.<br>Minimum value = 0<br>Maximum value = 65535
weight	<Double>	Read-write	Weight for the target host. Aids host selection when two or more hosts have the same priority. A larger number indicates greater weight.<br>Minimum value = 0<br>Maximum value = 65535
port	<Double>	Read-write	Port on which the target host listens for client requests.<br>Minimum value = 0<br>Maximum value = 65535
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 NetScaler appliance uses either the DNS zones minimum TTL or, if the SOA record is not available on the appliance, the default value of 3600.<br>Default value: 3600<br>Minimum value = 0<br>Maximum value = 2147483647
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.<br>Possible values = ALL, ADNS, PROXY
authtype	<String>	Read-only	Record type.<br>Possible values = ALL, ADNS, PROXY
__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>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"dnssrvrec":{
      "domain":<String_value>,
      "target":<String_value>,
      "priority":<Double_value>,
      "weight":<Double_value>,
      "port":<Double_value>,
      "ttl":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/dnssrvrec/domain_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/dnssrvrec/domain_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"dnssrvrec":{
      "domain":<String_value>,
      "target":<String_value>,
      "priority":<Double_value>,
      "weight":<Double_value>,
      "port":<Double_value>,
      "ttl":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"dnssrvrec":{
      "domain":<String_value>,
      "target":<String_value>,
      "ttl":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/dnssrvrec

Query-parameters:

args

http://<NSIP>/nitro/v1/config/dnssrvrec?args= "domain":<String_value>, "target":<String_value>, "type":<String_value>,

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

filter

http://<NSIP>/nitro/v1/config/dnssrvrec?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<NS_IP>/nitro/v1/config/dnssrvrec?view=summary

Use this query-parameter to get the summary output of dnssrvrec resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/dnssrvrec?pagesize=#no;pageno=#no

Use this query-parameter to get the dnssrvrec resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/dnssrvrec?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "dnssrvrec": [ {
      "domain":<String_value>,
      "target":<String_value>,
      "type":<String_value>,
      "priority":<Double_value>,
      "weight":<Double_value>,
      "port":<Double_value>,
      "ttl":<Double_value>,
      "authtype":<String_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/dnssrvrec?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",dnssrvrec: [ { "__count": "#no"} ] }