This is a cache of https://docs.openshift.com/acs/4.2/cli/installing-the-roxctl-cli.html. It is a snapshot of the page at 2024-11-23T17:52:42.773+0000.
Installing the roxctl <strong>cli</strong> | roxctl <strong>cli</strong> | Red Hat Advanced Cluster Security for Kubernetes 4.2
    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
×

Installing the roxctl cli

roxctl is a command-line interface (cli) for running commands on Red Hat Advanced Cluster Security for Kubernetes (RHACS). You can install the roxctl cli by downloading the binary or you can run the roxctl cli from a container image.

Installing the roxctl cli by downloading the binary

You can install the roxctl cli to interact with RHACS from a command-line interface. You can install roxctl on Linux, Windows, or macOS.

Installing the roxctl cli on Linux

You can install the roxctl cli binary on Linux by using the following procedure.

Procedure

  1. Download the latest version of the roxctl cli:

    $ curl -O https://mirror.openshift.com/pub/rhacs/assets/4.2.5/bin/Linux/roxctl

  2. Make the roxctl binary executable:

    $ chmod +x roxctl

  3. Place the roxctl binary in a directory that is on your PATH:

    To check your PATH, execute the following command:

    $ echo $PATH
Verification

  • Verify the roxctl version you have installed:

    $ roxctl version

Installing the roxctl cli on macOS

You can install the roxctl cli binary on macOS by using the following procedure.

Procedure

  1. Download the latest version of the roxctl cli:

    $ curl -O https://mirror.openshift.com/pub/rhacs/assets/4.2.5/bin/Darwin/roxctl

  2. Remove all extended attributes from the binary:

    $ xattr -c roxctl

  3. Make the roxctl binary executable:

    $ chmod +x roxctl

  4. Place the roxctl binary in a directory that is on your PATH:

    To check your PATH, execute the following command:

    $ echo $PATH
Verification

  • Verify the roxctl version you have installed:

    $ roxctl version

Installing the roxctl cli on Windows

You can install the roxctl cli binary on Windows by using the following procedure.

Procedure

  • Download the latest version of the roxctl cli:

    $ curl -O https://mirror.openshift.com/pub/rhacs/assets/4.2.5/bin/Windows/roxctl.exe
Verification

  • Verify the roxctl version you have installed:

    $ roxctl version

Running the roxctl cli from a container

The roxctl client is the default entry point in the RHACS roxctl image. To run the roxctl client in a container image:

Prerequisites

  • You must first generate an authentication token from the RHACS portal.

Procedure

  1. Log in to the registry.redhat.io registry.

    $ docker login registry.redhat.io

  2. Pull the latest container image for the roxctl cli.

    $ docker pull registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.2.5

After you install the cli, you can run it by using the following command:

$ docker run -e ROX_API_TOKEN=$ROX_API_TOKEN \
  -it registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.2.5 \
  -e $ROX_CENTRAL_ADDRESS <command>

In Red Hat Advanced Cluster Security Cloud Service (RHACS Cloud Service), when using roxctl commands that require the Central address, use the Central instance address as displayed in the Instance Details section of the Red Hat Hybrid Cloud Console. For example, use acs-ABCD12345.acs.rhcloud.com instead of acs-data-ABCD12345.acs.rhcloud.com.
Verification

  • Verify the roxctl version you have installed.

    $ docker run -it registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.2.5 version