This API has a deprecated equivalent from v7.0U1.
List Guest Networking Interfaces
Returns information about the networking interfaces in the guest operating system.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/networking/interfaces
Path Parameters
Path Parameters
string
vm
Required
Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
VmGuestNetworkingInterfacesInfo
of type application/json
Information about the interfaces configured in the guest operating system. Interfaces are ordered in a guest operating system specific determined order.
[
{
"dns": {
"ip_addresses": [
"string"
],
"search_domains": [
"string"
]
},
"dns_values": {
"domain_name": "string",
"host_name": "string"
},
"ip": {
"dhcp": {
"ipv4_enabled": false,
"ipv6_enabled": false
},
"ip_addresses": [
{
"ip_address": "string",
"origin": "OTHER",
"prefix_length": 0,
"state": "PREFERRED"
}
]
},
"mac_address": "string",
"nic": "string",
"wins_servers": [
"string"
]
}
]
dns
Optional
DNS configuration of the adapter. See Networking.Info.dns for system wide settings. If unset then not assigned by the Guest OS.
dns_values
Optional
Client DNS values. Data assigned by DNS. If unset no DNS assigned value exists.
ip
Optional
IP configuration settings of the adapter If unset then not supported by the Guest OS.
string
mac_address
Optional
MAC address of the adapter. If unset then not supported by the Guest OS.
string
nic
Optional
Link to the corresponding virtual device. 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.
array of
string
wins_servers
Optional
The IP addresses of any WINS name servers for the adapter. If unset then not supported by the Guest OS.
Errors
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListVmGuestNetworkingInterfaces -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/guest/networking/interfaces
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/guest/networking/interfaces
x-vmw-doc-operation: list
Availability
Added in 7.0U2
