Sun Java System Access Manager Policy Agent 2.2 Guide for JBoss Application Server 4.0

agentadmin --usage

Note –

This option lists other options available with the agentadmin command, including the --getUuid option. However, the --getUuid option was not available in the original build of Agent for JBoss Application Server 4.0. All the same, the --getUuid option is available in hot patch builds of this agent.

This section demonstrates the format and use of the agentadmin command with the --usage option.

Example 2–19 Command Format: agentadmin --usage

The following example illustrates the format of the agentadmin command with the --usage option:

./agentadmin --usage

No arguments are currently supported with the agentadmin command when using the --usage option.

Example 2–20 Command Usage: agentadmin --usage

Issuing the agentadmin command with the --usage option provides you with a list of the options available with the agentadmin program and a short explanation of each option. The following text is the output you receive after issuing this command:

./agentadmin --usage 

Usage: agentadmin <option> [<arguments>]

The available options are:
--install: Installs a new Agent instance.
--uninstall: Uninstalls an existing Agent instance.	
--listAgents: Displays details of all the configured agents.
--agentInfo: Displays details of the agent corresponding to the specified agent ID.
--version: Displays the version information.	
--encrypt: Encrypts a given string.
--getEncryptKey: Generates an Agent Encryption key.
--uninstallAll: Uninstalls all the agent instances.
--getUuid: Retrieves a universal ID for valid identity types.
--usage: Display the usage message.
--help: Displays a brief help message. 

The preceding output serves as the content for the table of agentadmin options, introduced at the beginning of this section.