Create Hardware Ethernet Deprecated
Adds a virtual Ethernet adapter to the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet
Path Parameters
Path 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VmHardwareEthernetCreateRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"allow_guest_control": false,
"backing": {
"distributed_port": "string",
"network": "string",
"type": "STANDARD_PORTGROUP"
},
"mac_address": "string",
"mac_type": "MANUAL",
"pci_slot_number": 0,
"start_connected": false,
"type": "E1000",
"upt_compatibility_enabled": false,
"wake_on_lan_enabled": false
}
}
Authentication
This operation uses the following authentication methods.
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.
Errors
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. | 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.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine or network backing is not found.
500
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.unable_to_allocate_resource : if the virtual machine already has the maximum number of supported Ethernet adapters. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
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":"STANDARD_PORTGROUP"},"mac_address":"string","mac_type":"MANUAL","pci_slot_number":0,"start_connected":false,"type":"E1000","upt_compatibility_enabled":false,"wake_on_lan_enabled":false}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/vcenter/vm/{vm}/hardware/ethernet
x-vmw-doc-operation: create
On This Page
Hardware Ethernet Operations
patch
delete
