Skip to main content
A newer release of this product is available.

Update DNS domain and server configurations

Contributors

PATCH /name-services/dns/{svm.uuid}

Updates DNS domain and server configurations of an SVM.

Important notes

  • Both DNS domains and servers can be modified.

  • The domains and servers fields cannot be empty.

  • IPv6 must be enabled if IPv6 family addresses are specified for the servers field.

  • The DNS server specified using the servers field is validated during this operation.

The validation fails in the following scenarios:

  1. The server is not a DNS server.

  2. The server does not exist.

  3. The server is unreachable.

Parameters

Name Type In Required Description

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

_links

_links

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".

servers

array[string]

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

svm

svm

Example request
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "domains": [
    "example.com",
    "example2.example3.com"
  ],
  "servers": [
    "10.224.65.20",
    "2001:db08:a0b:12f0::1"
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

8847360

Only admin or data SVMs allowed

8847361

Exceeded the maximum number of domains allowed. Maximum of six domains only

8847362

Exceeded the maximum number of name servers allowed. Maximum of three name servers only

8847392

Domain name cannot be an IP address

8847393

Top level domain name is invalid

8847394

FQDN name voilated the limitations

8847399

One or more of the specified DNS servers do not exist or cannot be reached

9240587

FQDN name cannot be empty

9240588

FQDN name is too long. Maximum supported length: 255 characters

9240590

FQDN name is reserved. Following names are reserved: "all", "local" and "localhost"

9240607

One of the FQDN labels is too long. Maximum supported length: 63 characters

23724130

Cannot use an IPv6 name server address because there are no IPv6 LIFs

Name Type Description

error

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

Name Type Description

self

href

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

dns

Name Type Description

_links

_links

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".

servers

array[string]

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

svm

svm

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.