Developer Documentation
Update Hardware Ethernet
Updates the configuration of a virtual Ethernet adapter.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet/{nic}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. |
| required |
|
string | Virtual Ethernet adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. |
Request Body
Request Body
Contains
UpdateRequestBody
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
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | EthernetUpdateSpec |
Specification for updating the virtual Ethernet adapter. |
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : if HOST_DEVICE is specified as the type. |
| 401 | Error | 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 | Error | 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 | Error | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. |
| 503 | Error | 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
patch
delete
