Getting Started with the Administration Utility

The Administration Utility provides command line access to several administrative functions. You can use it in a script, allowing you to automate certain administrative tasks. You can also use it interactively. Not all administrative functions are available in the Administration Utility. Use Management Console to access the functions that are not available in the Administration Utility.

Note: The Administration Utility requires Java 8 or later. If you are installing the Administration Utility on the same computer where the Spectrum™ Technology Platform server is installed, Java 8 is already installed since it is included with the server. If you want to install the Administration Utility on another computer, make sure that the computer has Java 8 or later installed.
  1. Open a web browser and go to the Spectrum™ Technology Platform Welcome Page at:

    http://<servername>:<port>

    For example, if you installed Spectrum™ Technology Platform on a computer named "myspectrumplatform" and it is using the default HTTP port 8080, you would go to:

    http://myspectrumplatform:8080

  2. Click Platform Client Tools.
  3. Click Command Line Clients.
  4. Under Administration Utility, click Download and download the zip file to the computer where you want to use the Administration Utility.
  5. Extract the contents of the zip file.
  6. To launch the command line interface, do one of the following:
    • If you are running the server on a Unix or Linux system, execute cli.sh.
    • If you are running the server on a Windows system, execute cli.cmd.
    Note: If necessary, modify the .sh or .cmd file to use the path to your Java installation.
  7. Connect to the Spectrum™ Technology Platform server that you want to administer. To connect to the server, execute the following command:

    connect --h servername:port --u username --p password --s SSLTrueOrFalse

    For example:

    connect --h myserver:8080 --u admin --p myPassword1 --s true

  8. Once you are connected you can execute commands. Note the following tips:
    • For a list of available commands, type help or press the tab key.
    • To auto-complete a command, type the first few characters then press the tab key. For example, typing us then pressing the tab key automatically completes the command user. Pressing the tab key again will display a list of all the user commands.
    • If you specify an option value that contains a space, enclose the value in double quotes.
  9. When you are done, type exit to exit the Administration Utility.