Installing the virtctl client

The virtctl client is a command-line utility for managing OKD Virtualization resources. It is available for Linux, Windows, and macOS.

Installing the virtctl client on Linux, Windows, and macOS

Download and install the virtctl client for your operating system.

Procedure

Navigate to Virtualization > Overview in the OKD web console.
Click the Download virtctl link on the upper right corner of the page and download the virtctl client for your operating system.
Install virtctl:
- For Linux:
  1. Decompress the archive file:
```
$ tar -xvf <virtctl-version-distribution.arch>.tar.gz
```
  2. Run the following command to make the virtctl binary executable:
```
$ chmod +x <path/virtctl-file-name>
```
  3. Move the virtctl binary to a directory in your PATH environment variable.
    
    You can check your path by running the following command:
```
$ echo $PATH
```
  4. Set the KUBECONFIG environment variable:
```
$ export KUBECONFIG=/home/<user>/clusters/current/auth/kubeconfig
```
- For Windows:
  1. Decompress the archive file.
  2. Navigate the extracted folder hierarchy and double-click the virtctl executable file to install the client.
  3. Move the virtctl binary to a directory in your PATH environment variable.
    
    You can check your path by running the following command:
```
C:\> path
```
- For macOS:
  1. Decompress the archive file.
  2. Move the virtctl binary to a directory in your PATH environment variable.
    
    You can check your path by running the following command:
```
echo $PATH
```

You can install the virtctl client on Fedora as an RPM after enabling the OKD Virtualization repository.

Enable the OKD Virtualization repository for your version of Fedora.

Prerequisites

Your system is registered to a Red Hat account with an active subscription to the “Red Hat Container Native Virtualization” entitlement.

Procedure

Install the virtctl client from the kubevirt-virtctl package.

Prerequisites

Procedure