Guest operation errors

Causes and remedies for the error codes of guest operations on files and programs inside a virtual machine.

`error.guest_operations_unavailable`

Text in the console: Guest operations are not available: the virtual machine is off, has no guest agent, or the agent blocks the command.
Meaning for API clients: Guest operations are not available (powered off, no agent, or agent blocks the command).
Code: FAILED_PRECONDITION, HTTP 412

Cause. The guest agent cannot run the operation. Either the virtual machine is powered off, it has no guest agent or the agent does not answer, or the agent is set to refuse this kind of operation (programs or files). The message of the API response carries the reason that the agent reported.

Remedy.

Power the virtual machine on when it is off: kyvernon vm power-on <id>.
Check that the guest agent runs inside the guest. Install or restart it when it does not. kyvernon vm guest validate <id> --username <user> probes whether guest operations are available.
When the agent blocks the operation, an administrator of the virtual machine changes its guest access with Edit guest access.
Pass on the reason from the response when the cause is still not clear.

`error.guest_file_exists`

Text in the console: The file already exists in the guest. Choose overwrite to replace it.
Meaning for API clients: The file already exists in the guest (use overwrite).
Code: ALREADY_EXISTS, HTTP 409

Cause. The file already exists in the guest, and the operation does not overwrite.

Remedy.

Choose another file name.
To replace the file on purpose, write it again with overwriting allowed. With the CLI, kyvernon vm guest write-file overwrites unless --no-overwrite is given, and kyvernon vm guest move-file <id> --src <path> --dst <path> --overwrite replaces the destination.

`error.guest_path_not_found`

Text in the console: The path does not exist in the guest.
Meaning for API clients: The path does not exist in the guest.
Code: NOT_FOUND, HTTP 404

Cause. The path does not exist in the guest, or a folder on the way to it does not exist.

Remedy.

List the parent folder in the guest: kyvernon vm guest list-files <id> --path <folder>.
Use a path as the guest writes it. Paths follow the operating system of the guest.
Create the missing folder first: kyvernon vm guest mkdir <id> --path <folder> --parents.

`error.guest_path_is_directory`

Text in the console: The path is a directory in the guest.
Meaning for API clients: The path is a directory in the guest.
Code: INVALID_ARGUMENT, HTTP 400

Cause. The path is a folder in the guest, and the operation works on files only, for example reading or deleting a file.

Remedy.

Give the path of a file.
To delete a folder, use kyvernon vm guest rmdir <id> --path <folder>. To move a folder, use kyvernon vm guest move-dir.

`error.guest_path_not_directory`

Text in the console: The path is not a directory in the guest.
Meaning for API clients: The path is not a directory in the guest.
Code: INVALID_ARGUMENT, HTTP 400

Cause. The path is a file in the guest, and the operation works on folders only, for example listing or creating files below it.

Remedy.

Give the path of a folder.
To work with the file itself, use the operation for files, for example kyvernon vm guest read-file <id> --path <file>.

`error.guest_directory_not_empty`

Text in the console: The directory in the guest is not empty.
Meaning for API clients: The directory is not empty in the guest.
Code: FAILED_PRECONDITION, HTTP 412

Cause. The folder in the guest still holds files, and the operation does not delete recursively.

Remedy.

Delete the content first, or delete the folder with its content: kyvernon vm guest rmdir <id> --path <folder> --recursive.
Check the content before you delete it recursively. The operation cannot be undone.