Chapter 6. Using the CLI tools
The two primary CLI tools used for managing resources in the cluster are:
-
The OpenShift Virtualization
virtctl
client -
The OpenShift Container Platform
oc
client
6.1. Prerequisites
-
You must install the
virtctl
client.
6.2. Virtctl client commands
The virtctl
client is a command-line utility for managing OpenShift Virtualization resources. The following table contains the virtctl
commands used throughout the OpenShift Virtualization documentation.
To view a list of options that you can use with a command, run it with the -h
or --help
flag. For example:
$ virtctl image-upload -h
Command | Description |
---|---|
| Start a virtual machine. |
| Stop a virtual machine. |
| Pause a virtual machine or virtual machine instance. The machine state is kept in memory. |
| Unpause a virtual machine or virtual machine instance. |
| Migrate a virtual machine. |
| Restart a virtual machine. |
| 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. |
| Connect to a serial console of a virtual machine instance. |
| Open a VNC connection to a virtual machine instance. |
| Upload a virtual machine image to a DataVolume that already exists. |
| Upload a virtual machine image to a new DataVolume. |
| Display the client and server version information. |
|
Display a descriptive list of |
6.3. OpenShift Container Platform client commands
The OpenShift Container Platform oc
client is a command-line utility for managing OpenShift Container Platform resources, including the virtual machine (vm
) and virtual machine instance (vmi
) object types.
You can use the -n <namespace>
flag to specify a different project.
Command | Description |
---|---|
|
Log in to the OpenShift Container Platform cluster as |
| Display a list of objects for the specified object type in the current project. |
| Display details of the specific resource in the current project. |
| Create a resource in the current project from a filename or from stdin. |
| Edit a resource in the current project. |
| Delete a resource in the current project. |
For more comprehensive information on oc
client commands, see the OpenShift Container Platform CLI tools documentation.