Skip to main content
REST API reference

Create a new IP to hostname mapping

PDFs

POST /name-services/local-hosts

Introduced In: 9.10

Creates a new cluster-scoped or SVM-scoped IP to hostname mapping. For SVM-scoped mappings, include either the SVM name as owner.name or the SVM UUID as owner.uuid in the request body, along with other necessary parameters. For cluster-scoped mappings, specifying owner.uuid or owner.name is not required.

Required properties

  • address - IPv4/IPv6 address in dotted form.

  • hostname - Canonical hostname.

Optional properties

  • owner.uuid or owner.name - Specify the name or UUID of an existing SVM to create an SVM-scoped IP-to-host mapping.

  • aliases - The list of aliases.

  • vserver services name-service dns hosts create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

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 
{
  "address": "123.123.123.123",
  "aliases": [
    "host1.sales.foo.com",
    "host2.sakes.foo.com"
  ],
  "hostname": "host.sales.foo.com",
  "owner": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "scope": "string"
}

Response

Status: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1377682

IPv6 is not enabled in the cluster.

1966253

IPv6 is not enabled in the cluster. Enable IPv6 using command "network options ipv6 modify -enabled true" and try again.

2621706

The specified owner UUID is incorrect for the specified owner name.

8912896

Only admin or data Vservers allowed.

23724055

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

23724155

The specified IPv4 address is not supported because it is one of the following: multicast, loopback, 0.0.0.0, or broadcast.

23724156

The specified IPv6 address is not supported because it is one of the following: ::, link-local, multicast, v4-compatible, v4-mapped, or loopback.

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

Definitions

See Definitions

href

Name Type Description

href

string

_links

owner

SVM, applies only to SVM-scoped objects.

Name Type Description

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

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.