This is a cache of https://docs.openshift.com/container-platform/4.3/cnv/cnv-using-the-cli-tools.html. It is a snapshot of the page at 2024-11-23T02:14:35.540+0000.
Using the <strong>cli</strong> tools | Container-native virtualization | OpenShift Container Platform 4.3
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history
×

Using the cli tools

The two primary cli tools used for managing resources in the cluster are:

  • The container-native virtualization virtctl client

  • The OpenShift Container Platform oc client

Prerequisites

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.

Table 1. virtctl client commands
Command Description

virtctl start <vm>

Start a virtual machine.

virtctl stop <vm>

Stop a virtual machine.

virtctl restart <vm>

Restart a virtual machine.

virtctl expose <vm>

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>

Connect to a serial console of a virtual machine instance.

virtctl vnc <vmi>

Open a VNC connection to a virtual machine instance.

virtctl image-upload <…​>

Upload a virtual machine image to a PersistentVolumeClaim.

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.

Table 2. oc commands
Command Description

oc login -u <user_name>

Log in to the OpenShift Container Platform cluster as <user_name>.

oc get <object_type>

Display a list of objects for the specified object type in the project.

oc describe <object_type> <resource_name>

Display details of the specific resource in the project.

oc create -f <object_config>

Create a resource in the project from a filename or from stdin.

oc edit <object_type> <resource_name>

Edit a resource in the project.

oc delete <object_type> <resource_name>

Delete a resource in the project.

For more comprehensive information on oc client commands, see the OpenShift Container Platform cli tools documentation.