This API has a deprecated equivalent from v7.0U1.
Update Hardware Ethernet
Updates the configuration of a virtual Ethernet adapter.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/ethernet/{nic}
Path Parameters
Path 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VmHardwareEthernetUpdateSpec of mimetype application/json
Required
Specification for updating the virtual Ethernet adapter.
{
"allow_guest_control": false,
"backing": {
"distributed_port": "string",
"network": "string",
"type": "STANDARD_PORTGROUP"
},
"mac_address": "string",
"mac_type": "MANUAL",
"start_connected": false,
"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. If unset, the value is unchanged.
backing
Optional
Physical resource backing for the virtual Ethernet adapter. This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.
If unset, the value is unchanged.
string
mac_address
Optional
MAC address. This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.
If unset, the value is unchanged. Must be specified if Ethernet.UpdateSpec.mac-type is MANUAL. Must be unset if the MAC address type is not MANUAL.
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
boolean
start_connected
Optional
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If unset, the value is unchanged.
boolean
upt_compatibility_enabled
Optional
Flag indicating whether Universal Pass-Through (UPT) compatibility should be enabled on this virtual Ethernet adapter. This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.
If unset, the value is unchanged. Must be unset if the emulation type of the virtual Ethernet adapter is not VMXNET3.
boolean
wake_on_lan_enabled
Optional
Flag indicating whether wake-on-LAN shoud be enabled on this virtual Ethernet adapter. This field may be modified at any time, and changes will be applied the next time the virtual machine is powered on.
If unset, the value is unchanged.
Authentication
This operation uses the following authentication methods.
Errors
Errors
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, virtual Ethernet adapter, or backing network is not found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | 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"
$VmHardwareEthernetUpdateSpec = Initialize-VmHardwareEthernetUpdateSpec -UptCompatibilityEnabled $false -MacType "MANUAL" -MacAddress "MyMacAddress" -WakeOnLanEnabled $false -Backing $VmHardwareEthernetBackingSpec -StartConnected $false -AllowGuestControl $false
Invoke-UpdateVmNicHardwareEthernet -Vm "MyVm" -Nic "MyNic" -VmHardwareEthernetUpdateSpec $VmHardwareEthernetUpdateSpec
cURL Command
curl -X PATCH -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","start_connected":false,"upt_compatibility_enabled":false,"wake_on_lan_enabled":false}' https://{api_host}/api/vcenter/vm/{vm}/hardware/ethernet/{nic}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: patch
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/ethernet/{nic}
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Hardware Ethernet Operations
patch
delete
