Successfully logged in as hqadmin at localhost:2099 hq-shell::hqadmin> help Available commands: agent - List, control, and install HQ agents alert - List and delete alerts cache - Manipulate HQ caches get - Get shell properties help - Gives help on shell commands livedata - Get live data from resources login - Login to the HQ system metric - List metrics and setup collection quit - Terminate the shell resource - View and update HQ resources set - Set shell properties sleep - Delay execution for the a number of seconds source - Read a file, executing the contents time - Time the execution of a shell command version - Retrieve HQ version information hq-shell::hqadmin> version Server reports version '3.1.1-EE' hq-shell::hqadmin>
The documentation states that I should see:
agent - Lists, controls, and installs HQ Agents * alert - Lists and deletes alerts alertdef - Adds, deletes, and lists alert definitions autoinventory - Runs scans, views queues, and approves changes control - Controls resources in HQ * 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 resourcetype - Views HQ resource types 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
The shell is the one found in the hyperic-hq-installer-3.1.1-EE-490-x86-linux.tgz archive.
As can be seen, "my" shell presents me with commands not mentioned in the documentation (livedata, cache) and misses some commands shown in the documentation (alertdef, autoinventory, control, resourcetype). The missing commands also do not work, so it is not just a wrong help message.
Am I reading the wrong documentation? Do I have the wrong shell?
The documentation is out-of-date, I'm afraid. I will be sure to get it updated. We actually had removed several commands due to incompatibility with the current architecture. In fact, we are working towards a different, more flexible command line architecture altogether for the next major revision of HQ.
The documentation is out-of-date, I'm afraid. I will be sure to get it updated. We actually had removed several commands due to incompatibility with the current architecture. In fact, we are working towards a different, more flexible command line architecture altogether for the next major revision of HQ.
It's also of note that when you have 'developer.commands' set to true, you will get some additional commands that are for development use only, hence they are not documented.
There is a two part answer to that question - there is a minor update (v 3.2) coming out early this winter, and a major release will come after that. The date for that is not set, but I would think it would be out by summer for sure.
