Skip to main content

Update a hostname mapping for an SVM

Contributors

PATCH /name-services/local-hosts/{owner.uuid}/{address}

Introduced In: 9.10

For a specified SVM and IP address, modifies the corresponding IP to hostname mapping.

  • vserver services name-service dns hosts modify

Parameters

Name Type In Required Description

owner.uuid

string

path

True

UUID of the owner to which this object belongs.

address

string

path

True

The IP address.

Request Body

Name Type Description

_links

_links

address

string

IPv4/IPv6 address in dotted form.

aliases

array[string]

The list of aliases.

hostname

string

Canonical hostname.

owner

owner

SVM, applies only to SVM-scoped objects.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

Example request
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "address": "123.123.123.123",
  "aliases": [
    "host1.sales.foo.com",
    "host2.sakes.foo.com"
  ],
  "hostname": "host.sales.foo.com",
  "owner": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "scope": "string"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

23724055

Internal error. Configuration for Vserver failed. Verify that the cluster is healthy, then try the command again. For further assistance, contact technical support.

Also see the table of common errors in the Response body overview section of this documentation.

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

Name Type Description

self

href

owner

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.

local_host

Name Type Description

_links

_links

address

string

IPv4/IPv6 address in dotted form.

aliases

array[string]

The list of aliases.

hostname

string

Canonical hostname.

owner

owner

SVM, applies only to SVM-scoped objects.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

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.