Installing the cfctl utility

Edit online

The cfctl utility is bundled inside the serviceability pod of your IBM® Cyber Fraud deployment. You must copy it to your local machine before running any support actions.

Procedure

Log in to your Red Hat OpenShift Container Platform cluster by typing one of the following commands, where <openshift_url> is the URL for your Red Hat OpenShift Container Platform environment.
- Using a username and password.
```
oc login <openshift_url> -u <username> -p <password>
```
- Using a token.
```
oc login --token=<token> --server=<openshift_url>
```

From the command line, retrieve the name of the serviceability pod.

POD=$(oc get pod --no-headers -lname=serviceability | cut -d' ' -f1)

Copy the cfctl binary to your local computer.

If your local computer operating system is Linux, type the following command.

rsync --rsh='oc rsh' -av -c --inplace --partial --append --progress \
  $POD:/opt/bin/cfctl-linux ./cfctl && chmod +x ./cfctl

If your local computer is a Mac with an Intel processor, type the following command.

rsync --rsh='oc rsh' -av -c --inplace --partial --append --progress \
  $POD:/opt/bin/cfctl-darwin-amd64 ./cfctl && chmod +x ./cfctl

If your local computer is a Mac with an ARM processor, type the following command.

rsync --rsh='oc rsh' -av -c --inplace --partial --append --progress \
  $POD:/opt/bin/cfctl-darwin ./cfctl && chmod +x ./cfctl

Move the utility to your global PATH.
```
sudo mv cfctl /usr/local/bin
```

What to do next

After installing, you can browse available actions and view documentation directly from the serviceability pod.

cfctl help                  # list all action groups
cfctl help all              # list all actions as a tree
cfctl help <group>          # list actions in a group
cfctl help <action>         # show parameters for an action
cfctl show <action>         # display full documentation for an action
cfctl --load help           # refresh the local action cache