Developer Documentation
Create Hardware Ethernet
Adds a virtual Ethernet adapter to the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet
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. |
Request Body
Request Body
Contains
CreateRequestBody
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
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | EthernetCreateSpec |
Specification for the new virtual Ethernet adapter. |
Response
Response
Response BodyResponse Body
200 OK returns
CreateResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: Virtual Ethernet adapter identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
Virtual Ethernet adapter identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. |
Errors
| Code | Returns | Description |
|---|---|---|
| 405 | Error | 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. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| 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. |
| 507 | Error | com.vmware.vapi.std.errors.unable_to_allocate_resource : if the virtual machine already has the maximum number of supported Ethernet adapters. |
| default | Error | Not available |
| 400 | Error | 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 | Error | 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 | Error | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. |
On This Page
Hardware Ethernet Operations
patch
delete
