REST API - get

vcenter vm guest networking: get

Returns information about the network configuration in the guest operating system. This operation was added in vSphere API 7.0.0.0.

Request:

HTTP request

GET https://{server}/rest/vcenter/vm/{vm}/guest/networking

Path Parameters

Name	Type	Description
Required
vm	string	Virtual machine ID.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "dns" : {
            "ip_addresses" : [
                "string",
                "string"
            ],
            "search_domains" : [
                "string",
                "string"
            ]
        },
        "dns_values" : {
            "domain_name" : "string",
            "host_name" : "string"
        }
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Information about the networking configuration in the guest operating system.
value.dns_values	dns_assigned_values	Client DNS values. Data assigned by DNS. This attribute was added in vSphere API 7.0.0.0. Optional. If unset no DNS assigned value exists.
value.dns_values.host_name	string	The host name portion of DNS name. For example, "esx01" part of esx01.example.com. This attribute was added in vSphere API 7.0.0.0.
value.dns_values.domain_name	string	The domain name portion of the DNS name. "example.com" part of esx01.example.com. This attribute was added in vSphere API 7.0.0.0.
value.dns	dns_config_info	Client DNS configuration. How DNS queries are resolved. This attribute was added in vSphere API 7.0.0.0. Optional. If unset no DNS assigned value exists.
value.dns.ip_addresses	string[]	The IP addresses of the DNS servers in order of use. IPv4 addresses are specified using dotted decimal notation. For example, "192.0.2.1". IPv6 addresses are 128-bit addresses represented as eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of the symbol '::' to represent multiple 16-bit groups of contiguous 0's only once in an address as described in RFC 2373. This attribute was added in vSphere API 7.0.0.0.
value.dns.search_domains	string[]	The domain in which to search for hosts, placed in order of preference. These are the domain name portion of the DNS names. This attribute was added in vSphere API 7.0.0.0.

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
404	not_found	if the virtual machine is not found.
503	service_unavailable	if VMware Tools is not running.