REST API - update

vcenter vm hardware parallel: update

Updates the configuration of a virtual parallel port.

Request:

HTTP request

PATCH https://{server}/rest/vcenter/vm/{vm}/hardware/parallel/{port}

Path Parameters

Name	Type	Description
Required
vm	string	Virtual machine identifier.
port	string	Virtual parallel port identifier.

Request Body Structure:

{
    "spec" : {
        "start_connected" : true,
        "backing" : {
            "file" : "string",
            "type" : "FILE",
            "host_device" : "string"
        },
        "allow_guest_control" : true
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
spec	update_spec	Specification for updating the virtual parallel port.
spec.backing	backing_spec	Physical resource backing for the virtual parallel port. This field may only be modified if the virtual machine is not powered on or the virtual parallel port is not connected. Optional. If unset, the value is unchanged.
spec.backing.type	string	Backing type for the virtual parallel port. Defines the valid backing types for a virtual parallel port. Value is one of: FILE: Virtual parallel port is backed by a file. HOST_DEVICE: Virtual parallel port is backed by a device on the host where the virtual machine is running.
spec.backing.file	string	Path of the file that should be used as the virtual parallel port backing. Optional. It is only relevant when type has value FILE. This field is optional and it is only relevant when the value of `type` is FILE.
spec.backing.host_device	string	Name of the device that should be used as the virtual parallel port backing. Optional. It is only relevant when type has value HOST_DEVICE. If unset, the virtual parallel port will be configured to automatically detect a suitable host device.
spec.start_connected	boolean	Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Optional. If unset, the value is unchanged.
spec.allow_guest_control	boolean	Flag indicating whether the guest can connect and disconnect the device. Optional. If unset, the value is unchanged.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
404	not_found	if the virtual machine or virtual parallel port is not found.
400	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.
500	resource_busy	if the virtual machine is busy performing another operation.
500	resource_inaccessible	if the virtual machine's configuration state cannot be accessed.
503	service_unavailable	if the system is unable to communicate with a service to complete the request.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user doesn't have the required privileges.