This API has a deprecated equivalent from v7.0U1.
Disconnect Hardware Ethernet
DescriptionDisconnects a virtual Ethernet adapter of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the Ethernet adapter is not connected to its backing resource. For a powered-off virtual machine, the Ethernet.update operation may be used to configure the virtual Ethernet adapter to start in the disconnected state when the virtual machine is powered on.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/ethernet/{nic}?action=disconnect
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"
Authentication
This operation uses the following authentication methods.
Code Samples
Code Samples
PowerCLI Client SDK Example
Invoke-DisconnectVmNicEthernet -Vm "MyVm" -Nic "MyNic"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware/ethernet/{nic}?action=disconnect
Errors
400
com.vmware.vapi.std.errors.already_in_desired_state : if the virtual Ethernet adapter is already disconnected. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not powered on.
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 virtual Ethernet adapter 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.
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/{nic}/disconnect
x-vmw-doc-operation: disconnect
Availability
Added in 7.0U2
On This Page
Hardware Ethernet Operations
delete
patch
