Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

dnssoarec

August 17, 2023
Contributed by: 
C

Configuration for SOA record resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
domain Read-write Domain name for which to add the SOA record.
Minimum length = 1
originserver Read-write Domain name of the name server that responds authoritatively for the domain.
Minimum length = 1
contact Read-write Email address of the contact to whom domain issues can be addressed. In the email address, replace the @ sign with a period (.). For example, enter domainadmin.example.com instead of domainadmin@example.com.
Minimum length = 1
serial Read-write The secondary server uses this parameter to determine whether it requires a zone transfer from the primary server.
Default value: 100
Minimum value = 0
Maximum value = 4294967294
refresh Read-write Time, in seconds, for which a secondary server must wait between successive checks on the value of the serial number.
Default value: 3600
Minimum value = 0
Maximum value = 4294967294
retry Read-write Time, in seconds, between retries if a secondary server’s attempt to contact the primary server for a zone refresh fails.
Default value: 3
Minimum value = 0
Maximum value = 4294967294
expire Read-write Time, in seconds, after which the zone data on a secondary name server can no longer be considered authoritative because all refresh and retry attempts made during the period have failed. After the expiry period, the secondary server stops serving the zone. Typically one week. Not used by the primary server.
Default value: 3600
Minimum value = 0
Maximum value = 4294967294
minimum Read-write Default time to live (TTL) for all records in the zone. Can be overridden for individual records.
Default value: 5
Minimum value = 0
Maximum value = 2147483647
ttl 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 Read-write Subnet for which the cached SOA record need to be removed.
type 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 Read-write Unique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
authtype Read-only Record type.
Possible values = ALL, ADNS, PROXY
__count Read-only count parameter

Operations

(click to see Properties)

ADD DELETE UPDATE UNSET 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec

HTTP Method:POST

Request Headers:

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

Request Payload: 


{"dnssoarec":{
<b>"domain":<String_value>,
</b><b>"originserver":<String_value>,
</b><b>"contact":<String_value>,
</b>"serial":<Double_value>,
"refresh":<Double_value>,
"retry":<Double_value>,
"expire":<Double_value>,
"minimum":<Double_value>,
"ttl":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec/domain_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 Citrix ADC specific errors). The response payload provides details of the error

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec

HTTP Method:PUT

Request Headers:

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

Request Payload: 


{"dnssoarec":{
<b>"domain":<String_value>,
</b>"originserver":<String_value>,
"contact":<String_value>,
"serial":<Double_value>,
"refresh":<Double_value>,
"retry":<Double_value>,
"expire":<Double_value>,
"minimum":<Double_value>,
"ttl":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec?action=unset

HTTP Method:POST

Request Headers:

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

Request Payload: 


{"dnssoarec":{
<b>"domain":<String_value>,
</b>"serial":true,
"refresh":true,
"retry":true,
"expire":true,
"minimum":true,
"ttl":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec?args=domain:<String_value>,type:<String_value>,nodeid:<Double_value>

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

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec?view=summary

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec?pagesize=#no;pageno=#no

Use this query-parameter to get the dnssoarec 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "dnssoarec": [ {
domain:<String_value>,type:<String_value>,nodeid:<Double_value>"originserver":<String_value>,
"contact":<String_value>,
"serial":<Double_value>,
"refresh":<Double_value>,
"retry":<Double_value>,
"expire":<Double_value>,
"minimum":<Double_value>,
"ttl":<Double_value>,
"authtype":<String_value>,
"ecssubnet":<String_value>
}]}

<!--NeedCopy-->

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec/domain_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec/domain_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec/domain_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "dnssoarec": [ {
domain:<String_value>,type:<String_value>,nodeid:<Double_value>"originserver":<String_value>,
"contact":<String_value>,
"serial":<Double_value>,
"refresh":<Double_value>,
"retry":<Double_value>,
"expire":<Double_value>,
"minimum":<Double_value>,
"ttl":<Double_value>,
"authtype":<String_value>,
"ecssubnet":<String_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnssoarec?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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
dnssoarec
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.