This API has a deprecated equivalent from v7.0U1.
Create Hardware Ethernet
Adds a virtual Ethernet adapter to the virtual machine.
Request
URLURL
https://{api_host}/api/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
VmHardwareEthernetCreateSpec of mimetype application/json
Required
Specification for the new virtual Ethernet adapter.
{
"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
}
boolean
allow_guest_control
Optional
Flag indicating whether the guest can connect and disconnect the device. Defaults to false if unset.
backing
Optional
Physical resource backing for the virtual Ethernet adapter. If unset, the system may try to find an appropriate backing. If one is not found, the request will fail.
string
mac_address
Optional
MAC address. Workaround for PR1459647
mac_type
Optional
The Ethernet.MacAddressType enumerated type defines the valid MAC address origins for a virtual Ethernet adapter.
MANUAL : MAC address is assigned statically.
GENERATED : MAC address is generated automatically.
ASSIGNED : MAC address is assigned by vCenter Server.
Possible values are: MANUAL , GENERATED , ASSIGNED
integer
pci_slot_number
Optional
Address of the virtual Ethernet adapter on the PCI bus. If the PCI address is invalid, the server will change when it the VM is started or as the device is hot added. If unset, the server will choose an available address when the virtual machine is powered on.
boolean
start_connected
Optional
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if unset.
type
Optional
The Ethernet.EmulationType enumerated type defines the valid emulation types for a virtual Ethernet adapter.
E1000 : E1000 ethernet adapter.
E1000E : E1000e ethernet adapter.
PCNET32 : AMD Lance PCNet32 Ethernet adapter.
VMXNET : VMware Vmxnet virtual Ethernet adapter.
VMXNET2 : VMware Vmxnet2 virtual Ethernet adapter.
VMXNET3 : VMware Vmxnet3 virtual Ethernet adapter.
Possible values are: E1000 , E1000E , PCNET32 , VMXNET , VMXNET2
boolean
upt_compatibility_enabled
Optional
Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter. If unset, UPT will not be enabled on the newly-created virtual Ethernet adapter.
boolean
wake_on_lan_enabled
Optional
Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter. Defaults to false if unset.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string
of type application/json
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
PowerCLI Client SDK Example
$VmHardwareEthernetBackingSpec = Initialize-VmHardwareEthernetBackingSpec -Type "STANDARD_PORTGROUP" -Network "MyNetwork" -DistributedPort "MyDistributedPort"
$VmHardwareEthernetCreateSpec = Initialize-VmHardwareEthernetCreateSpec -Type "E1000" -UptCompatibilityEnabled $false -MacType "MANUAL" -MacAddress "MyMacAddress" -PciSlotNumber 0 -WakeOnLanEnabled $false -Backing $VmHardwareEthernetBackingSpec -StartConnected $false -AllowGuestControl $false
Invoke-CreateVmHardwareEthernet -Vm "MyVm" -VmHardwareEthernetCreateSpec $VmHardwareEthernetCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"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}/api/vcenter/vm/{vm}/hardware/ethernet
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/ethernet
x-vmw-doc-operation: create
Availability
Added in 7.0U2
On This Page
Hardware Ethernet Operations
patch
delete
