Update 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.
Updates the configuration of a virtual Ethernet adapter.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet/{nic}
Parameters
Parameters
string
vm
Required
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
string
nic
Required
Virtual Ethernet adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
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
VmHardwareEthernetUpdateRequestBody of type application/json (required){
"spec": {
"allow_guest_control": false,
"backing": {
"distributed_port": "string",
"network": "string",
"type": "enum"
},
"mac_address": "string",
"mac_type": "enum",
"start_connected": false,
"upt_compatibility_enabled": false,
"wake_on_lan_enabled": false
}
}cURL Command
curl -X PATCH -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","start_connected":false,"upt_compatibility_enabled":false,"wake_on_lan_enabled":false}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet/{nic}
Errors
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
400
com.vmware.vapi.std.errors.invalid_argument : if HOST_DEVICE is specified as the type.
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.
404
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine, virtual Ethernet adapter, or backing network 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.
On This Page
Hardware Ethernet Operations
delete
patch
