Host Network System Get Dns Config

Host Network System Get Dns Config

Deprecated as of vSphere API 5.5, which is moved to each NetStackInstance. This only works on the default NetStackInstance.

Client-side DNS configuration.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/dnsConfig
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostNetworkSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostDnsConfig of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "dhcp": false,
    "virtualNicDevice": "string",
    "ipv6VirtualNicDevice": "string",
    "hostName": "string",
    "domainName": "string",
    "address": [
        "string"
    ],
    "searchDomain": [
        "string"
    ]
}
boolean
dhcp
Required

The flag to indicate whether or not DHCP (dynamic host control protocol) is used to determine DNS configuration automatically.

string
virtualNicDevice
Optional

If DHCP is enabled, the DHCP DNS of the vmkernel nic will override the system's DNS.

This field applies to both IPv4 and IPv6 DNS settings if ipv6VirtualNicDevice is unset, otherwise it is applicable only for IPv4 setting. This field is ignored if DHCP is disabled by the dhcp property.

string
ipv6VirtualNicDevice
Optional

If DHCP is enabled, the IPv6 DHCP DNS of the vmkernel nic will override the system's IPv6 DNS.

This field is ignored if DHCP is disabled by the dhcp property.

string
hostName
Required

The host name portion of DNS name.

For example, "esx01".

Note: When DHCP is not enabled, the property can be set explicitly. When DHCP is enabled, the property reflects the current DNS configuration, but cannot be set. The hostName can't have character '.' in it when set explicitly.

string
domainName
Required

The domain name portion of the DNS name.

For example, "vmware.com".

Note: When DHCP is not enabled, the property can be set explicitly. When DHCP is enabled, the property reflects the current DNS configuration, but cannot be set.

array of string
address
Optional

The IP addresses of the DNS servers, placed in order of preference.

Note: When DHCP is not enabled, the property can be set explicitly. When DHCP is enabled, the property reflects the current DNS configuration, but cannot be set.

array of string
searchDomain
Optional

The domain in which to search for hosts, placed in order of preference.

Note: When DHCP is not enabled, the property can be set explicitly. When DHCP is enabled, the property reflects the current DNS configuration, but cannot be set.


Host Network System Operations
POST
Host Network System Add Port Group
POST
Host Network System Add Service Console Virtual Nic
POST
Host Network System Add Virtual Nic
POST
Host Network System Add Virtual Switch
GET
Host Network System Get Available Field
GET
Host Network System Get Capabilities
GET
Host Network System Get Console Ip Route Config
GET
Host Network System Get Dns Config
GET
Host Network System Get Ip Route Config
GET
Host Network System Get Network Config
GET
Host Network System Get Network Info
GET
Host Network System Get Offload Capabilities
GET
Host Network System Get Value
POST
Host Network System Query Network Hint
POST
Host Network System Refresh Network System
POST
Host Network System Remove Port Group
POST
Host Network System Remove Service Console Virtual Nic
POST
Host Network System Remove Virtual Nic
POST
Host Network System Remove Virtual Switch
POST
Host Network System Restart Service Console Virtual Nic
POST
Host Network System Set Custom Value
POST
Host Network System Update Console Ip Route Config
POST
Host Network System Update Dns Config
POST
Host Network System Update Ip Route Config
POST
Host Network System Update Ip Route Table Config
POST
Host Network System Update Network Config
POST
Host Network System Update Physical Nic Link Speed
POST
Host Network System Update Port Group
POST
Host Network System Update Service Console Virtual Nic
POST
Host Network System Update Virtual Nic
POST
Host Network System Update Virtual Switch