CLI Reference

Added by Matt Hughes, last edited by Eric Johnson on Dec 13, 2007  (view change)

CLI Reference

Many of the commands FUSE HQ supports through its web user interface and also available through its CLI. This page enumerates the available commands.

If you have any comments or suggestions for this help page, please submit them at the bottom of the page by clicking Add Comment.

Accessing the CLI

To access the HQ CLI:

  1. Start the shell using the hq-shell.sh script located in the shell installation directory.
  2. Upon startup, the shell provides a login prompt: 
    [user@localhost shell]$ ./hq-shell.sh
hq-shell::not-logged-in>
  3. Log in using the same credentials you use in the web UI: 
    hq-shell::not-logged-in> login hqadmin@localhost
Password:
Successfully logged in as hqadmin at localhost:2099

    Once logged in, you can begin using the shell. To get a list of available commands, type help at the prompt.

    Automating CLI Commands at Shell Startup
    When the HQ shell starts, it reads commands from the file ~/.hq/shellrc. You can use this file to have HQ automatically execute commands when the shell starts. For example, if the login command is added to shellrc, then you will be automatically logged in to the shell during startup.
    _back to top_

Available CLI Commands

Following is the complete list of top-level commands supported by the HQ CLI. Click the command name for a complete description of the command and its sub-commands.

Command Description
agent Lists, controls, and installs HQ Agents
alert Lists and deletes alerts
autoinventory Runs and manages auto-discovery scans
get Gets shell properties
help Gives help on shell commands
login Logs in to the HQ system
metric Lists metrics and sets up metric collection
quit Terminates the shell
resource Views and updates HQ resources
set Sets shell properties
sleep Delays execution of an HQ command for a number of seconds
source Reads a file and executes the contents
time Times the execution of a shell command
version Retrieves HQ version information

back to top

Return to the User Manual.

Labels

 
(None)