This API has a deprecated equivalent from v7.0U1.
Update Hardware Serial
Updates the configuration of a virtual serial port.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/serial/{port}
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
string
port
Required
Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.
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
VmHardwareSerialUpdateSpec of mimetype application/json
Required
Specification for updating the virtual serial port.
{
"allow_guest_control": false,
"backing": {
"file": "string",
"host_device": "string",
"network_location": "string",
"no_rx_loss": false,
"pipe": "string",
"proxy": "string",
"type": "FILE"
},
"start_connected": false,
"yield_on_poll": 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 serial port. This field may only be modified if the virtual machine is not powered on or the virtual serial port is not connected.
If unset, the value is unchanged.
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
yield_on_poll
Optional
CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host. This field may be modified at any time, and changes applied to a connected virtual serial port take effect immediately.
If unset, the value is unchanged.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if one or more of the fields specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual serial port.
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 serial port 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.
Code Samples
PowerCLI Client SDK Example
$VmHardwareSerialBackingSpec = Initialize-VmHardwareSerialBackingSpec -Type "FILE" -File "MyFile" -HostDevice "MyHostDevice" -Pipe "MyPipe" -NoRxLoss $false -NetworkLocation "MyNetworkLocation" -Proxy "MyProxy"
$VmHardwareSerialUpdateSpec = Initialize-VmHardwareSerialUpdateSpec -YieldOnPoll $false -Backing $VmHardwareSerialBackingSpec -StartConnected $false -AllowGuestControl $false
Invoke-UpdateVmPortHardwareSerial -Vm "MyVm" -Port "MyPort" -VmHardwareSerialUpdateSpec $VmHardwareSerialUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"allow_guest_control":false,"backing":{"file":"string","host_device":"string","network_location":"string","no_rx_loss":false,"pipe":"string","proxy":"string","type":"FILE"},"start_connected":false,"yield_on_poll":false}' https://{api_host}/api/vcenter/vm/{vm}/hardware/serial/{port}
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/serial/{port}
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Hardware Serial Operations
patch
delete
