This API has a deprecated equivalent from v7.0U1.
Create Hardware Serial
Adds a virtual serial port to the virtual machine.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/serial
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
VmHardwareSerialCreateSpec of mimetype application/json
Required
Specification for the new 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. Defaults to false if unset.
backing
Optional
Physical resource backing for the virtual serial port. If unset, defaults to automatic detection of a suitable host device.
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.
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. If unset, defaults to false.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string
of type application/json
Virtual serial port identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not powered off.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.error : if the system reported that the serial port device was created but was unable to confirm the creation because the identifier of the new device 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 serial ports. | 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
$VmHardwareSerialBackingSpec = Initialize-VmHardwareSerialBackingSpec -Type "FILE" -File "MyFile" -HostDevice "MyHostDevice" -Pipe "MyPipe" -NoRxLoss $false -NetworkLocation "MyNetworkLocation" -Proxy "MyProxy"
$VmHardwareSerialCreateSpec = Initialize-VmHardwareSerialCreateSpec -YieldOnPoll $false -Backing $VmHardwareSerialBackingSpec -StartConnected $false -AllowGuestControl $false
Invoke-CreateVmHardwareSerial -Vm "MyVm" -VmHardwareSerialCreateSpec $VmHardwareSerialCreateSpec
cURL Command
curl -X POST -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
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/serial
x-vmw-doc-operation: create
Availability
Added in 7.0U2
On This Page
Hardware Serial Operations
patch
delete
