Update Hardware Parallel
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Updates the configuration of a virtual parallel port.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/parallel/{port}
Parameters
Parameters
string
vm
Required
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
string
port
Required
Virtual parallel port identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VmHardwareParallelUpdateRequestBody of type application/json (required){
"spec": {
"allow_guest_control": false,
"backing": {
"file": "string",
"host_device": "string",
"type": "enum"
},
"start_connected": false
}
}cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"allow_guest_control":false,"backing":{"file":"string","host_device":"string","type":"enum"},"start_connected":false}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/parallel/{port}
Errors
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
404
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine or virtual parallel port is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed.
409
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 parallel port. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation.
On This Page
Hardware Parallel Operations
patch
delete
