Skip to main content

Retrieve DNS configurations for all SVMs

Contributors
PDFs

GET /name-services/dns

Introduced In: 9.6

Retrieves the DNS configurations of all SVMs. Specify 'scope' as 'svm' to retrieve the DNS configuration of all the data SVMs. Specify 'scope' as 'cluster' to retrieve the DNS configuration of the cluster.

Advanced properties

  • 'tld_query_enabled'

  • 'source_address_match'

  • 'packet_query_match'

  • 'status' property retrieves the status of each name server of the DNS configuration for an SVM.

  • 'service_ips' property is displayed only when both service.name and SVM are set.

  • vserver services name-service dns show

  • vserver services name-service dns check

  • vserver services name-service dns dynamic-update show

  • vserver services access-check dns srv-lookup

Learn more

Parameters

Name Type In Required Description

status.state

string

query

False

Filter by status.state

  • Introduced in: 9.9

status.message

string

query

False

Filter by status.message

  • Introduced in: 9.9

status.code

integer

query

False

Filter by status.code

  • Introduced in: 9.9

status.name_server

string

query

False

Filter by status.name_server

  • Introduced in: 9.9

timeout

integer

query

False

Filter by timeout

  • Introduced in: 9.9

  • Max value: 5

  • Min value: 1

service_ips

string

query

False

Filter by service_ips

  • Introduced in: 9.14

uuid

string

query

False

Filter by uuid

  • Introduced in: 9.13

source_address_match

boolean

query

False

Filter by source_address_match

  • Introduced in: 9.9

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

tld_query_enabled

boolean

query

False

Filter by tld_query_enabled

  • Introduced in: 9.9

packet_query_match

boolean

query

False

Filter by packet_query_match

  • Introduced in: 9.9

domains

string

query

False

Filter by domains

  • maxLength: 255

  • minLength: 1

scope

string

query

False

Filter by scope

  • Introduced in: 9.9

dynamic_dns.fqdn

string

query

False

Filter by dynamic_dns.fqdn

  • Introduced in: 9.9

dynamic_dns.use_secure

boolean

query

False

Filter by dynamic_dns.use_secure

  • Introduced in: 9.9

dynamic_dns.enabled

boolean

query

False

Filter by dynamic_dns.enabled

  • Introduced in: 9.9

dynamic_dns.time_to_live

string

query

False

Filter by dynamic_dns.time_to_live

  • Introduced in: 9.9

attempts

integer

query

False

Filter by attempts

  • Introduced in: 9.9

  • Max value: 4

  • Min value: 1

servers

string

query

False

Filter by servers

service.name

string

query

False

The string required to look up the SRV record on the DNS server.

  • Introduced in: 9.14

service.address_type

string

query

False

The type of IP address to be looked up on the DNS server.

  • Introduced in: 9.14

  • Default value: 1

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Max value: 120

  • Min value: 0

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of DNS domain records.

records

array[dns]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "attempts": 1,
      "domains": [
        "example.com",
        "example2.example3.com"
      ],
      "dynamic_dns": {
        "fqdn": "example.com",
        "time_to_live": "P2D"
      },
      "scope": "string",
      "servers": [
        "10.224.65.20",
        "2001:db08:a0b:12f0::1"
      ],
      "service_ips": [
        "10.224.65.20",
        "2001:db08:a0b:12f0::1"
      ],
      "status": [
        {
          "code": 6684732,
          "message": "string",
          "name_server": "10.10.10.10",
          "state": "up"
        }
      ],
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "timeout": 2,
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

dynamic_dns

Name Type Description

enabled

boolean

Enable or disable Dynamic DNS (DDNS) updates for the specified SVM.

fqdn

string

Fully Qualified Domain Name (FQDN) to be used for dynamic DNS updates.

skip_fqdn_validation

boolean

Enable or disable FQDN validation.

time_to_live

string

Time to live value for the dynamic DNS updates, in an ISO-8601 duration formatted string. Maximum Time To Live is 720 hours(P30D in ISO-8601 format) and the default is 24 hours(P1D in ISO-8601 format).

use_secure

boolean

Enable or disable secure dynamic DNS updates for the specified SVM.

status

Status of each of the DNS name server configured for the specified SVM.

Name Type Description

code

integer

Code corresponding to the status message. Code is 0 when the state is 'up'.

message

string

Detailed description of the validation state if the state is 'down' or the response time of the DNS server if the state is 'up'.

name_server

string

The IP address of the DNS server. The address can be either an IPv4 or an IPv6 address.

state

string

The validation status of the DNS server.

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

dns

Name Type Description

_links

_links

attempts

integer

Number of attempts allowed when querying the DNS name servers.

domains

array[string]

A list of DNS domains. Domain names have the following requirements:

  • The name must contain only the following characters: A through Z, a through z, 0 through 9, ".", "-" or "_".

  • The first character of each label, delimited by ".", must be one of the following characters: A through Z or a through z or 0 through 9.

  • The last character of each label, delimited by ".", must be one of the following characters: A through Z, a through z, or 0 through 9.

  • The top level domain must contain only the following characters: A through Z, a through z.

  • The system reserves the following names:"all", "local", and "localhost".

dynamic_dns

dynamic_dns

packet_query_match

boolean

Indicates whether or not the query section of the reply packet is equal to that of the query packet.

scope

string

Set to "svm" for DNS owned by an SVM, otherwise set to "cluster".

servers

array[string]

The list of IP addresses of the DNS servers. Addresses can be either IPv4 or IPv6 addresses.

service_ips

array[string]

List of IP addresses for a DNS service. Addresses can be IPv4, IPv6 or both.

skip_config_validation

boolean

Indicates whether or not the validation for the specified DNS configuration is disabled.

source_address_match

boolean

Indicates whether or not the DNS responses are from a different IP address to the IP address the request was sent to.

status

array[status]

Status of all the DNS name servers configured for the specified SVM.

svm

svm

SVM, applies only to SVM-scoped objects.

timeout

integer

Timeout values for queries to the name servers, in seconds.

tld_query_enabled

boolean

Enable or disable top-level domain (TLD) queries.

uuid

string

UUID of the DNS object.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.