Key Agent Command Line Interface

Last updated
Save as PDF

The Key Agent can be managed and controlled from your command line using the Command Line Interface (CLI). The CLI allows you to send commands to the Key Agent directly from your operating system’s command line.

In order to send commands to the Key Agent, you must first invoke the CLI. The process for this depends on the operating system where the key agent is installed.

Invoke the CLI

Windows

No batch script is needed. Instead, call java directly to enter the following command from the command prompt:

cd keyagent
java -classpath .\shnkeyagent.jar com.shn.keyagent.cli.ShnKeyAgentCli

Linux

For Key Agent v3.6, use a shell script to enter the following:

kumar@suren-dev-proxy:~$ cd shnka
kumar@suren-dev-proxy:~/shnka$ pwd
/home/surendrakumar/shnka
kumar@suren-dev-proxy:~/shnka$ ./shnka-cli.sh

For Key Agent v5.1.1, use a shell script to enter the following:

kumar@suren-dev-proxy:~/shnka$./KeyAgentInstallerI4j-5.0.1.1-unix64.sh -Venv=https://www.myshn.net/shnproxyapi -VEnableLocalKeystoreOption=true

Mac OSX

No batch script is needed. Instead, call java directly to enter the following command from the terminal:

cd keyagent
java -classpath ./shnkeyagent.jar com.shn.keyagent.cli.ShnKeyAgentCli

Use CLI Commands

Once the CLI has been invoked, enter the following commands to get information about the Key Server or modify Key Server settings:

set keyserverSets the keyserver information. It needs the keystore password, which can not be passed via parameter.
show keyserver detailsReturns the keyserver settings. (The password is not shown).
show keyserver connectivity Shows the connectivity between the keyagent and keyserver.
set env Sets the Skyhigh CASB environment details. It needs the dashboard password, which can not be passed via parameter.
show env details Shows the environment settings.
show env connectivity Shows the connectivity between the keyagent and the Skyhigh CASB dashboard (env).
set proxy Sets the proxy details. (If the password is needed, then it will ask).
show proxy details Shows the proxy details.