dnsmxrec
Configuration for MX record resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| domain | <String> | Read-write | Domain name for which to add the MX record.<br>Minimum length = 1 |
| mx | <String> | Read-write | Host name of the mail exchange server.<br>Minimum length = 1 |
| pref | <Double> | Read-write | Priority number to assign to the mail exchange server. A domain name can have multiple mail servers, with a priority number assigned to each server. The lower the priority number, the higher the mail servers priority. When other mail servers have to deliver mail to the specified domain, they begin with the mail server with the lowest priority number, and use other configured mail servers, in priority order, as backups.<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:<br>* ADNS - Display all authoritative address records.<br>* PROXY - Display all proxy address records.<br>* ALL - Display all address records.<br>Default value: ADNS<br>Possible values = ALL, ADNS, PROXY |
| nodeid | <Double> | Read-write | Unique number that identifies the cluster node.<br>Minimum value = 0<br>Maximum value = 31 |
| authtype | <String> | Read-only | Record type.<br>Possible values = ALL, ADNS, PROXY |
| __count | <Double> | 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 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/dnsmxrec
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"dnsmxrec":{
"domain":<String_value>,
"mx":<String_value>,
"pref":<Double_value>,
"ttl":<Double_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/dnsmxrec/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 NetScaler-specific errors). The response payload provides details of the error
update
URL: http://<netscaler-ip-address>/nitro/v1/config/dnsmxrec
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"dnsmxrec":{
"domain":<String_value>,
"mx":<String_value>,
"pref":<Double_value>,
"ttl":<Double_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/dnsmxrec?action=unset
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"dnsmxrec":{
"domain":<String_value>,
"mx":<String_value>,
"ttl":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/dnsmxrec
Query-parameters:
args
http://<netscaler-ip-address>/nitro/v1/config/dnsmxrec?args=domain:<String_value>,type:<String_value>,nodeid:<Double_value>
Use this query-parameter to get dnsmxrec resources based on additional properties.
attrs
http://<netscaler-ip-address>/nitro/v1/config/dnsmxrec?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/dnsmxrec?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of dnsmxrec resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http://<netscaler-ip-address>/nitro/v1/config/dnsmxrec?view=summary
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination
http://<netscaler-ip-address>/nitro/v1/config/dnsmxrec?pagesize=#no;pageno=#no
Use this query-parameter to get the dnsmxrec 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:
{ "dnsmxrec": [ {
domain:<String_value>,type:<String_value>,nodeid:<Double_value> "mx":<String_value>,
"pref":<Double_value>,
"ttl":<Double_value>,
"authtype":<String_value>
}]}
get
URL: http://<netscaler-ip-address>/nitro/v1/config/dnsmxrec/domain_value<String>
Query-parameters:
attrs
http://<netscaler-ip-address>/nitro/v1/config/dnsmxrec/domain_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/dnsmxrec/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 NetScaler-specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "dnsmxrec": [ {
domain:<String_value>,type:<String_value>,nodeid:<Double_value> "mx":<String_value>,
"pref":<Double_value>,
"ttl":<Double_value>,
"authtype":<String_value>
}]}
count
URL: http://<netscaler-ip-address>/nitro/v1/config/dnsmxrec?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:
{ "dnsmxrec": [ { "__count": "#no"} ] }