vcenter vm guest networking interfaces: info

The info structure describes a virtual network adapter configured in the guest operating system. This structure was added in vSphere API 7.0.0.

Representation:

{
    "mac_address""string",
    "ip"{
        "ip_addresses"[
            {
                "origin""OTHER",
                "ip_address""string",
                "prefix_length"1,
                "state""PREFERRED"
            },
            {
                "origin""OTHER",
                "ip_address""string",
                "prefix_length"1,
                "state""PREFERRED"
            }
        ],
        "dhcp"{
            "ipv6_enabled"true,
            "ipv4_enabled"true
        }
    },
    "dns"{
        "ip_addresses"[
            "string",
            "string"
        ],
        "search_domains"[
            "string",
            "string"
        ]
    },
    "wins_servers"[
        "string",
        "string"
    ],
    "nic""obj-103",
    "dns_values"{
        "domain_name""string",
        "host_name""string"
    }
}

Attributes:

Name Type Description
Required
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.

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.

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.

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.

ip.ip_addresses ip_address_info[] IP addresses configured on the interface. This attribute was added in vSphere API 7.0.0.

ip.dhcp.ipv4_enabled boolean True if IPv4 DHCP is enabled, false otherwise. This attribute was added in vSphere API 7.0.0.

ip.dhcp.ipv6_enabled boolean True if IPv6 DHCP is enabled, false otherwise. This attribute was added in vSphere API 7.0.0.

Optional
dns_values dns_assigned_values Client DNS values. Data assigned by DNS. This attribute was added in vSphere API 7.0.0.

Optional. If unset no DNS assigned value exists.

mac_address string MAC address of the adapter. This attribute was added in vSphere API 7.0.0.

Optional. If unset then not supported by the Guest OS.

dns dns_config_info DNS configuration of the adapter. See vcenter.vm.guest.networking.info.dns for system wide settings. This attribute was added in vSphere API 7.0.0.

Optional. If unset then not assigned by the Guest OS.

ip ip_config_info IP configuration settings of the adapter. This attribute was added in vSphere API 7.0.0.

Optional. If unset then not supported by the Guest OS.

ip.dhcp dhcp_config_info Client side DHCP for an interface. This attribute was added in vSphere API 7.0.0.

Optional. If unset the IP was not configured by DHCP.

wins_servers string[] The IP addresses of any WINS name servers for the adapter. This attribute was added in vSphere API 7.0.0.

Optional. If unset then not supported by the Guest OS.

nic string Link to the corresponding virtual device. This attribute was added in vSphere API 7.0.0.

Optional. If unset then the interface is not backed by a virtual device.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.