Console errors

Causes and remedies for the error codes raised when a console ticket is issued or used.

`error.console.powered_off`

Text in the console: The virtual machine is powered off.
Meaning for API clients: The VM is powered off; a console needs a running VM.
Code: FAILED_PRECONDITION, HTTP 412

Cause. A console ticket was requested for a virtual machine that is neither powered on nor suspended. A console needs a running virtual machine.

Remedy.

Power the virtual machine on: kyvernon vm power-on <id>. In the console, use Power on.
Open the console again with Open console.

`error.console.not_available`

Text in the console: This virtual machine has no graphical console.
Meaning for API clients: The VM runs without a graphical console (no console.vnc).
Code: FAILED_PRECONDITION, HTTP 412

Cause. The host agent reported that the virtual machine runs without a graphical console, for example because it uses a runtime that has no VNC display.

Remedy.

Use the serial console instead: kyvernon vm serial-log <id> prints the tail of the serial log. In the console, use Serial log.
When a graphical console is needed, an administrator changes the runtime of the virtual machine. Pass on the message id error.console.not_available and the name of the virtual machine.

`error.console.host_disconnected`

Text in the console: The host of the virtual machine is not connected.
Meaning for API clients: The VM's host is not connected.
Code: UNAVAILABLE, HTTP 503

Cause. The host that runs the virtual machine is not connected to the controller, so the console cannot be reached.

Remedy.

Check the state of the host in the inventory, then try again when it is connected.
An administrator checks the host and its agent. A host that was disconnected on purpose stays disconnected until kyvernon host reconnect <id> runs. Pass on the name of the virtual machine and the time of the error.

`error.console.rate_limited`

Text in the console: Too many console tickets. Retry in {retryAfterSeconds} seconds.
Meaning for API clients: Too many console tickets for this session.
Code: RESOURCE_EXHAUSTED, HTTP 429

Argument	What it holds
`retryAfterSeconds`	the seconds to wait before a new ticket is issued.

Cause. The session asked for more than 20 console tickets within one minute. Kyvernon limits the tickets per session.

Remedy.

Wait the number of seconds shown in the message.
Reuse the console that is open instead of opening a new one each time. A ticket is valid for 30 seconds and works once.

`error.console.ticket_invalid`

Text in the console: The console ticket is invalid, used or expired.
Meaning for API clients: The console ticket is unknown, used or expired.
Code: UNAUTHENTICATED, HTTP 401

Cause. The console ticket is unknown, was used already, or is older than 30 seconds. A ticket works once and only for the session that asked for it.

Remedy.

Request a new ticket and connect at once: kyvernon vm console ticket <id>. In the console, use Open console again.
Do not store or share tickets. A new connection always needs a new ticket.