mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
db3a3955df
We never supported `virtctl rename` so we should not document them. Signed-off-by: Dan Kenigsberg <danken@redhat.com>
82 lines
2.7 KiB
Plaintext
82 lines
2.7 KiB
Plaintext
// 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 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 --kubeconfig=$KUBECONFIG <vmi_name>`
|
|
|Open a VNC (Virtual Network Client) connection to a virtual machine instance. Access the graphical console of a virtual machine instance through a VNC which requires a remote viewer on your local machine.
|
|
|
|
|`virtctl vnc --kubeconfig=$KUBECONFIG --proxy-only=true <vmi-name>`
|
|
|Display the port number and connect manually to the virtual machine instance by using any viewer through the VNC connection.
|
|
|
|
|`virtctl vnc --kubeconfig=$KUBECONFIG --port=<port-number> <vmi-name>`
|
|
|Specify a port number to run the proxy on the specified port, if that port is available. If a port number is not specified, the proxy runs on a random port.
|
|
|
|
|`virtctl image-upload dv <datavolume_name> --image-path=</path/to/image> --no-create`
|
|
|Upload a virtual machine image to a data volume 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 data volume.
|
|
|
|
|`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.
|
|
|===
|