Retrieve IP to hostname mappings for all SVMs in a cluster
Obtains IP to hostname mappings for all SVMs in the cluster. Use this to view the DNS configurations and ensure accurate name resolution across the cluster.
HTTP method and endpoint
GET /name-services/local-hosts
Introduced in
ONTAP 9.10
Usage notes
Retrieves all IP to hostname mappings for all SVMs of the cluster.
Related ONTAP commands
-
vserver services name-service dns hosts show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
hostname |
string |
query |
False |
Filter by hostname
|
owner.uuid |
string |
query |
False |
Filter by owner.uuid |
owner.name |
string |
query |
False |
Filter by owner.name |
scope |
string |
query |
False |
Filter by scope |
aliases |
string |
query |
False |
Filter by aliases |
address |
string |
query |
False |
Filter by address |
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.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of hosts to IP records. |
records |
array[local_host] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"_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"
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
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 |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
owner
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
local_host
| Name | Type | Description |
|---|---|---|
_links |
||
address |
string |
IPv4/IPv6 address in dotted form. |
aliases |
array[string] |
The list of aliases. |
hostname |
string |
Canonical hostname. |
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. |