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

Create a new IP to hostname mapping

Contributors

POST /name-services/local-hosts

Introduced In: 9.10

Creates a new IP to hostname mapping.

Required properties

  • owner.uuid or owner.name - Existing SVM in which to create IP to host mapping.

  • address - IPv4/IPv6 address in dotted form.

  • hostname - Canonical hostname.

  • vserver services name-service dns hosts create

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

_links

_links

address

string

IPv4/IPv6 address in dotted form.

aliases

array[string]

The list of aliases.

hostname

string

Canonical hostname.

owner

owner

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: 201, Created

Error

Status: Default, Error
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

owner

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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

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

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.