JBoss Community Archive (Read Only)

RHQ 4.9

RHQ Agent Prompt Commands

The agent can process simple prompt commands entered as either input from a file (see command line option --input) or as input from the keyboard (assuming --daemon is not specified as a command line argument). You can see the list of prompt commands that are accepted by the agent by entering "help" at the prompt. To get detailed help on a particular prompt command, enter "help" followed by the name of the prompt command you are interested in. The following are the current set of prompt commands that the agent understands:

avail

Get availability of inventoried resources

config

Manages the agent configuration

debug

Provides features to help debug the agent

discovery

Asks a plugin to run a server scan discovery

download

Downloads a file from the RHQ Server

dumpspool

Shows the entries found in the command spool file

exit

Shuts down the agent's communications services and kills the agent

failover

Shows/updates the HA failover list

gc

Helps free up memory by invoking the garbage collector

getconfig

Displays one, several or all agent configuration preferences

help

Shows help for a given command

identify

Asks to identify a remote server

inventory

Provides information about the current inventory of resources

log

Configures some settings for the log messages

metrics

Shows the agent metrics

native

Accesses native system information

pc

Starts and stops the plugin container and all deployed plugins

ping

Pings the RHQ Server

piql

Executes a PIQL query to search for running processes

plugins

Updates the agent plugins with the latest versions from the server

quit

An alias for 'exit'

register

Registers this agent with the RHQ Server

sender

Controls the command sender to start or stop sending commands

setconfig

Sets an agent configuration preference

setup

Sets up the agent configuration by asking a series of questions

shutdown

Shuts down all communications services without killing the agent

sleep

Puts the agent prompt to sleep for a given amount of seconds

start

Starts the agent comm services so it can accept remote requests

timer

Times how long it takes to execute another prompt command

update

Provides agent update functionality

version

Shows the agent version information

JBoss.org Content Archive (Read Only), exported from JBoss Community Documentation Editor at 2020-03-13 08:48:44 UTC, last content change 2013-09-18 19:43:37 UTC.