Chapter 5. Using the CLI tools
The two primary CLI tools used for managing resources in the cluster are:
-
The container-native virtualization
virtctlclient -
The OpenShift Container Platform
occlient
5.1. Prerequisites
-
You must install the
virtctlclient.
5.2. Virtctl client commands
The virtctl client is a command-line utility for managing container-native virtualization resources. The following table contains the virtctl commands used throughout the container-native virtualization documentation.
| Command | Description |
|---|---|
|
| Start a virtual machine. |
|
| Stop 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 PersistentVolumeClaim. |
5.3. OpenShift Container Platform client commands
The OpenShift Container Platform oc client is a command-line utility for managing OpenShift Container Platform resources. The following table contains the oc commands used throughout the container-native virtualization documentation.
| Command | Description |
|---|---|
|
|
Log in to the OpenShift Container Platform cluster as |
|
| Display a list of objects for the specified object type in the project. |
|
| Display details of the specific resource in the project. |
|
| Create a resource in the project from a filename or from stdin. |
|
| Edit a resource in the project. |
|
| Delete a resource in the project. |
For more comprehensive information on oc client commands, see the OpenShift Container Platform CLI tools documentation.
