7.3.3. Agent Prompt Commands
The agent processes prompt commands that are passed to it, either interactively through the agent prompt or from an input file that can be passed when the start script is launched. Agent prompt commands (listed in Table 16, “Agent Prompt Commands”) can be used to manage resource (by checking availability, running discovery, or checking monitoring information) or to manage the agent itself (such as registering with a server, loading plug-ins, or viewing or reloading configuration settings).
| Prompt Command | Description |
|---|---|
|
avail
|
Provides availability of inventoried resources.
|
|
config
|
Manages the agent configuration.
|
|
debug
|
Provides features to help debug the agent.
|
|
discovery
|
Asks a plug-in to run a server scan discovery.
|
|
download
|
Downloads a file from the JBoss ON 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 or updates the high availability server 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 plug-in container and all deployed plug-ins.
|
|
ping
|
Pings the JBoss ON server.
|
|
piql
|
Executes a PIQL query to search for running processes.
|
|
plugins
|
Updates the agent plug-ins with the latest versions from the server.
|
|
quit
|
Exits the agent prompt (without stopping the agent).
|
|
register
|
Registers this agent with the JBoss ON server.
|
|
schedules
|
Retrieves measurement schedule information for the specified resource.
|
|
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.
|
