Update Hardware Serial
Updates the configuration of a virtual serial port.
Request
URLURL
Path Parameters
Path Parameters
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.
Header Parameters
Header Parameters
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
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
}
Flag indicating whether the guest can connect and disconnect the device. If unset, the value is unchanged.
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.
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If unset, the value is unchanged.
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
Errors
Errors
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.
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
com.vmware.vapi.std.errors.not_found : if the virtual machine or virtual serial port is not found.
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.
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
x-vmw-doc-operation: update