roxctl CLI Red Hat Advanced Cluster Security for Kubernetes 4.7 roxctl CLI Red Hat OpenShift Documentation Team

Commands:
arch="USD(uname -m | sed "s/x86_64//")"; arch="USD{arch:+-USDarch}"
curl -L -f -o roxctl "https://mirror.openshift.com/pub/rhacs/assets/4.7.0/bin/Linux/roxctlUSD{arch}"
chmod +x roxctl
echo USDPATH
roxctl version
arch="USD(uname -m | sed "s/x86_64//")"; arch="USD{arch:+-USDarch}"
curl -L -f -o roxctl "https://mirror.openshift.com/pub/rhacs/assets/4.7.0/bin/Darwin/roxctlUSD{arch}"
xattr -c roxctl
chmod +x roxctl
echo USDPATH
roxctl version
curl -f -O https://mirror.openshift.com/pub/rhacs/assets/4.7.0/bin/Windows/roxctl.exe
roxctl version
docker login registry.redhat.io
docker pull registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.7.0
docker run -e ROX_API_TOKEN=USDROX_API_TOKEN -it registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.7.0 -e USDROX_CENTRAL_ADDRESS <command>
docker run -it registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.7.0 version
export ROX_ENDPOINT= <host:port> 1
roxctl central whoami
UserID: <redacted> User name: <redacted> Roles: APIToken creator, Admin, Analyst, Continuous Integration, Network Graph Viewer, None, Sensor Creator, Vulnerability Management Approver, Vulnerability Management Requester, Vulnerability Manager, Vulnerability Report Creator Access: rw Access rw Administration rw Alert rw CVE rw Cluster rw Compliance rw Deployment rw DeploymentExtension rw Detection rw Image rw Integration rw K8sRole rw K8sRoleBinding rw K8sSubject rw Namespace rw NetworkGraph rw NetworkPolicy rw Node rw Secret rw ServiceAccount rw VulnerabilityManagementApprovals rw VulnerabilityManagementRequests rw WatchedImage rw WorkflowAdministration
export ROX_API_TOKEN=<api_token>
roxctl central debug dump --token-file <token_file>
export ROX_ENDPOINT= <central_hostname:port>
roxctl central login
Please complete the authorization flow in the browser with an auth provider of your choice. If no browser window opens, please click on the following URL: http://127.0.0.1:xxxxx/login INFO: Received the following after the authorization flow from Central: INFO: Access token: <redacted> 1 INFO: Access token expiration: 2023-04-19 13:58:43 +0000 UTC 2 INFO: Refresh token: <redacted> 3 INFO: Storing these values under USDHOME/.roxctl/login... 4
export ROX_API_TOKEN=<api_token>
export ROX_ENDPOINT=<address>:<port_number>
export ROX_ENDPOINT= <host:port> 1
roxctl sensor generate k8s --name <cluster_name> --central "USDROX_ENDPOINT"
roxctl sensor generate openshift --openshift-version <ocp_version> --name <cluster_name> --central "USDROX_ENDPOINT" 1
roxctl sensor generate k8s --central wss://stackrox-central.example.com:443
./sensor- <cluster_name> /sensor.sh
roxctl sensor get-bundle <cluster_name_or_id>
roxctl cluster delete --name= <cluster_name>
export ROX_ENDPOINT= <host:port> 1
roxctl deployment check --file = <yaml_filename> -o csv
roxctl deployment check --file= <yaml_filename> -o table --headers POLICY-NAME,SEVERITY --row-jsonpath-expressions="{results. .violatedPolicies. .name,results. .violatedPolicies. .severity}"
roxctl deployment check --file=<yaml_filename> \ 1 --namespace=<cluster_namespace> \ 2 --cluster=<cluster_name_or_id> \ 3 --verbose 4
roxctl image check --image= <image_name>
roxctl image scan --image <image_name>
export ROX_ENDPOINT= <host:port> 1
kubectl logs -n stackrox <central_pod>
oc logs -n stackrox <central_pod>
roxctl central debug log
roxctl central debug log --level= <log_level> 1
roxctl central debug dump
roxctl image scan --image= <image_registry> / <image_name> \ 1 --cluster= <cluster_detail> \ 2 [flags] 3
{ "Id": "sha256:3f439d7d71adb0a0c8e05257c091236ab00c6343bc44388d091450ff58664bf9", 1 "name": { 2 "registry": "image-registry.openshift-image-registry.svc:5000", 3 "remote": "default/image-stream", 4 "tag": "latest", 5 "fullName": "image-registry.openshift-image-registry.svc:5000/default/image-stream:latest" 6 }, [...]
roxctl [command] [flags]
roxctl central [command] [flags]
roxctl central backup [flags]
roxctl central cert [flags]
roxctl central crs [command] [flags]
roxctl central crs generate <crs name> [flags]
roxctl central crs list [flags]
roxctl central crs revoke <CRS unique identifier or name> [flags]
roxctl central login [flags]
roxctl central whoami [flags]
roxctl central db [flags]
roxctl central db restore <file> [flags] 1
roxctl central db generate [flags]
roxctl central db generate k8s [flags]
roxctl central db restore cancel [flags]
roxctl central db restore status [flags]
roxctl central db generate k8s pvc [flags]
roxctl central db generate openshift [flags]
roxctl central db generate k8s hostpath [flags]
roxctl central db generate openshift pvc [flags]
roxctl central db generate openshift hostpath [flags]
roxctl central debug [flags]
roxctl central debug db [flags]
roxctl central debug log [flags]
roxctl central debug dump [flags]
roxctl central debug db stats [flags]
roxctl central debug authz-trace [flags]
roxctl central debug db stats reset [flags]
roxctl central debug download-diagnostics [flags]
roxctl central generate [flags]
roxctl central generate k8s [flags]
roxctl central generate k8s pvc [flags]
roxctl central generate openshift [flags]
roxctl central generate interactive [flags]
roxctl central generate k8s hostpath [flags]
roxctl central generate openshift pvc [flags]
roxctl central generate openshift hostpath [flags]
roxctl central init-bundles [flag]
roxctl central init-bundles list [flags]
roxctl central init-bundles revoke <init_bundle_ID or name> [<init_bundle_ID or name> ...] [flags] 1
roxctl central init-bundles fetch-ca [flags]
roxctl central init-bundles generate <init_bundle_name> [flags] 1
roxctl central userpki [flags]
roxctl central userpki list [flags]
roxctl central userpki create name [flags]
roxctl central userpki delete id|name [flags]
roxctl cluster [command] [flags]
roxctl cluster delete [flags]
roxctl collector [command] [flags]
roxctl collector support-packages [flags]
roxctl collector support-packages upload [flags]
roxctl completion [bash|zsh|fish|powershell]
roxctl declarative-config [command] [flags]
roxctl declarative-config lint [flags]
roxctl declarative-config create [flags]
roxctl declarative-config create role [flags]
roxctl declarative-config create notifier [flags]
roxctl declarative-config create access-scope [flags]
roxctl declarative-config create auth-provider [flags]
roxctl declarative-config create permission-set [flags]
roxctl declarative-config create notifier splunk [flags]
roxctl declarative-config create notifier generic [flags]
roxctl declarative-config create auth-provider iap [flags]
roxctl declarative-config create auth-provider oidc [flags]
roxctl declarative-config create auth-provider saml [flags]
roxctl declarative-config create auth-provider userpki [flags]
roxctl declarative-config create auth-provider openshift-auth [flags]
roxctl deployment [command] [flags]
roxctl deployment check [flags]
roxctl helm [command] [flags]
roxctl helm output <central_services or secured_cluster_services> [flags] 1
roxctl helm derive-local-values --output <path> \ 1 <central_services> [flags] 2
roxctl image [command] [flags]
roxctl image sbom [flags]
roxctl image scan [flags]
roxctl image check [flags]
roxctl netpol [command] [flags]
roxctl netpol generate <folder_path> [flags] 1
roxctl netpol connectivity [flags]
roxctl netpol connectivity map <folder_path> [flags] 1
roxctl netpol connectivity diff [flags]
roxctl scanner [command] [flags]
roxctl scanner generate [flags]
roxctl scanner upload-db [flags]
roxctl scanner download-db [flags]
roxctl sensor [command] [flags]
roxctl sensor generate [flags]
roxctl sensor generate k8s [flags]
roxctl sensor generate openshift [flags]
roxctl sensor get-bundle <cluster_details> [flags] 1
roxctl sensor generate-certs <cluster_details> [flags] 1
roxctl version [flags]