Create Hardware Ethernet
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Adds a virtual Ethernet adapter to the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet
Parameters
Parameters
string
vm
Required
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VmHardwareEthernetCreateRequestBody of type application/json (required){
"spec": {
"allow_guest_control": false,
"backing": {
"distributed_port": "string",
"network": "string",
"type": "enum"
},
"mac_address": "string",
"mac_type": "enum",
"pci_slot_number": 0,
"start_connected": false,
"type": "enum",
"upt_compatibility_enabled": false,
"wake_on_lan_enabled": false
}
}
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareEthernetCreateResponseBody
of type application/json
Virtual Ethernet adapter identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
{
"value": "string"
}
string
value
Optional
Virtual Ethernet adapter identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"allow_guest_control":false,"backing":{"distributed_port":"string","network":"string","type":"enum"},"mac_address":"string","mac_type":"enum","pci_slot_number":0,"start_connected":false,"type":"enum","upt_compatibility_enabled":false,"wake_on_lan_enabled":false}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet
Errors
405
com.vmware.vapi.std.errors.unsupported : if the guest operating system of the virtual machine is not supported and spec includes unset fields that default to guest-specific values.
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
507
com.vmware.vapi.std.errors.unable_to_allocate_resource : if the virtual machine already has the maximum number of supported Ethernet adapters.
400
com.vmware.vapi.std.errors.invalid_argument : if the specified PCI address is out of bounds, HOST_DEVICE is specified as the type, or a backing cannot be found in the case that backing is left unset.
404
com.vmware.vapi.std.errors.error : if the system reported that the Ethernet adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.
if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine or network backing is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed.
409
com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
On This Page
Hardware Ethernet Operations
delete
patch
