<commit_before>// Module included in the following assemblies:
//
// * virt/virt-using-the-cli-tools.adoc

[id="virt-virtctl-commands_{context}"]
= Virtctl client commands

The `virtctl` client is a command-line utility for managing {VirtProductName}
resources. The following table contains the `virtctl` commands used throughout
the {VirtProductName} documentation.

To view a list of options that you can use with a command, run it with the `-h` or `--help` flag. For example:
+
[source,terminal]
----
$ virtctl image-upload -h
----

.`virtctl` client commands

[width="100%",cols="42%,58%",options="header",]
|===
|Command |Description

|`virtctl start <vm_name>`
|Start a virtual machine.

|`virtctl stop <vm_name>`
|Stop a virtual machine.

|`virtctl pause vm\|vmi <object_name>`
|Pause a virtual machine or virtual machine instance. The machine state is kept
in memory.

|`virtctl unpause vm\|vmi <object_name>`
|Unpause a virtual machine or virtual machine instance.

|`virtctl migrate <vm_name>`
|Migrate a virtual machine.

|`virtctl rename <vm_name> <new_vm_name>`
|Rename a stopped virtual machine.

|`virtctl restart <vm_name>`
|Restart a virtual machine.

|`virtctl expose <vm_name>`
|Create a service that forwards a designated port
of a virtual machine or virtual machine instance and expose the service on
the specified port of the node.

|`virtctl console <vmi_name>`
|Connect to a serial console of a virtual machine instance.

|`virtctl vnc <vmi_name>`
|Open a VNC connection to a virtual machine instance.

|`virtctl image-upload dv <datavolume_name> --image-path=</path/to/image> --no-create`
|Upload a virtual machine image to a DataVolume that already exists.

|`virtctl image-upload dv <datavolume_name> --size=<datavolume_size> --image-path=</path/to/image>`
|Upload a virtual machine image to a new DataVolume.

|`virtctl version`
|Display the client and server version information.

|`virtctl help`
|Display a descriptive list of `virtctl` commands.
|===<commit_msg>CNV Jira story CNV-4333 Adding fslist, guestosinfo, and userlist commands to Virtctl commands table in Virtual client commands subsection of Using the CLI tools section<commit_after>// Module included in the following assemblies:
//
// * virt/virt-using-the-cli-tools.adoc

[id="virt-virtctl-commands_{context}"]
= Virtctl client commands

The `virtctl` client is a command-line utility for managing {VirtProductName}
resources. The following table contains the `virtctl` commands used throughout
the {VirtProductName} documentation.

To view a list of options that you can use with a command, run it with the `-h` or `--help` flag. For example:
+
[source,terminal]
----
$ virtctl image-upload -h
----

.`virtctl` client commands

[width="100%",cols="42%,58%",options="header",]
|===
|Command |Description

|`virtctl start <vm_name>`
|Start a virtual machine.

|`virtctl stop <vm_name>`
|Stop a virtual machine.

|`virtctl pause vm\|vmi <object_name>`
|Pause a virtual machine or virtual machine instance. The machine state is kept
in memory.

|`virtctl unpause vm\|vmi <object_name>`
|Unpause a virtual machine or virtual machine instance.

|`virtctl migrate <vm_name>`
|Migrate a virtual machine.

|`virtctl rename <vm_name> <new_vm_name>`
|Rename a stopped virtual machine.

|`virtctl restart <vm_name>`
|Restart a virtual machine.

|`virtctl expose <vm_name>`
|Create a service that forwards a designated port
of a virtual machine or virtual machine instance and expose the service on
the specified port of the node.

|`virtctl console <vmi_name>`
|Connect to a serial console of a virtual machine instance.

|`virtctl vnc <vmi_name>`
|Open a VNC connection to a virtual machine instance.

|`virtctl image-upload dv <datavolume_name> --image-path=</path/to/image> --no-create`
|Upload a virtual machine image to a DataVolume that already exists.

|`virtctl image-upload dv <datavolume_name> --size=<datavolume_size> --image-path=</path/to/image>`
|Upload a virtual machine image to a new DataVolume.

|`virtctl version`
|Display the client and server version information.

|`virtctl help`
|Display a descriptive list of `virtctl` commands.

|`virtctl fslist <vmi_name>`
|Return a full list of file systems available on the guest machine.

|`virtctl guestosinfo <vmi_name>`
|Return guest agent information about the operating system.

|`virtctl userlist <vmi_name>`
|Return a full list of logged-in users on the guest machine.
|===
{'fraction_non_alphanumeric': 0.1072961373390558, 'fraction_numerical': 0.0040659588886379034, 'mean_word_length': 4.927710843373494, 'pattern_counts': {'":': 0, '<': 38, '<?xml version=': 0, '>': 38, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '504054', 'n_tokens_mistral': 1402, 'n_tokens_neox': 1344, 'n_words': 546}