Serial APIs
The Serial service provides operations for configuring the virtual serial ports of a virtual machine.
Operations
POST
Connect Vm Port Serial
Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.
POST
Create Vm Hardware Serial
Adds a virtual serial port to the virtual machine.
GET
List Vm Hardware Serial
Returns commonly used information about the virtual serial ports belonging to the virtual machine.
DELETE
Delete Vm Port Hardware Serial
Removes a virtual serial port from the virtual machine.
GET
Get Vm Port Hardware Serial
Returns information about a virtual serial port.
PATCH
Update Vm Port Hardware Serial
Updates the configuration of a virtual serial port.
POST
Disconnect Vm Port Serial
Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.