Web agents developed as part of the OpenSSO project, including the Apache HTTP Server 2.2 agent, project now use the agentadmin program for installation, uninstallation, and other tasks.
The location of the agentadmin program is:
PolicyAgent-base/bin
For more information about PolicyAgent-base, see Example 2–15.
Consideration for the agentadmin program for web agents include:
Web agent installation and uninstallation is achieved with the agentadmin command.
All tasks performed by the agentadmin program, except those involving uninstallation, require the acceptance of a license agreement. This agreement is presented only the first time you use the program.
The following table describes the agentadmin command options that can be used with web agents.
A detailed explanation of each option follows the table.
Option |
Task Performed |
---|---|
--install |
Installs a new agent instance |
--uninstall |
Uninstalls an existing agent instance |
--listAgents |
Displays details of all configured agents |
--agentInfo |
Displays details of the agent corresponding to the specified agent IDs |
--version |
Displays the version information |
--usage |
Displays the usage message |
--help |
Displays a brief help message |
This section demonstrates the format and use of the agentadmin command with the --install option.
The following example illustrates the format of the agentadmin command with the --install option:
./agentadmin --install [--useResponse] [--saveResponse] filename
The following arguments are supported with the agentadmin command when using the --install option:
Use this argument to save all supplied responses to a state file, or response file, represented as filename in command examples. The response file, or state file, can then be used for silent installations.
Use this argument to install a web agent in silent mode as all installer prompts are answered with responses previously saved to a response file, represented as filename in command examples. When this argument is used, the installer runs in non-interactive mode. At which time, user interaction is not required.
Use this argument to specify the name of a file that will be created as part of the processing of this command. This file stores your responses when this argument is used in conjunction with the --saveResponse argument and provides your responses when this argument is used in conjunction with the --useResponse argument.
When you issue the agentadmin command, you can choose the --install option. With the --install option, you can choose the --saveResponse argument, which requires a file name be provided. The following example illustrates this command when the file name is myfile:
./agentadmin --install --saveResponse myfile
Once the installer has executed the preceding command successfully, the responses are stored in a state file that can be used for later runs of the installer.
If desired, you can modify the state file and configure the second installation with a different set of configuration parameters.
Then you can issue another command that uses the ./agentadmin --install command and the name of the file that you just created with the --saveResponse argument. The difference between the previous command and this command is that this command uses the --useResponse argument instead of the --saveResponse argument. The following example illustrates this command:
./agentadmin --install --useResponse myfile
With this command, the installation prompts run the installer in silent mode, registering all debug messages in the install logs directory.
This section demonstrates the format and use of the agentadmin command with the --uninstall option.
The following example illustrates the format of the agentadmin command with the --uninstall option:
./agentadmin --uninstall [--useResponse] [--saveResponse] filename
The following arguments are supported with the agentadmin command when using the --uninstall option:
Use this argument to save all supplied responses to a state file, or response file, represented as filename in command examples. The response file, or state file, can then be used for silent uninstallations.
Use this argument to uninstall a web agent in silent mode as all uninstaller prompts are answered with responses previously saved to a response file, represented as filename in command examples. When this argument is used, the uninstaller runs in non-interactive mode. At which time, user interaction is not required.
Use this argument to specify the name of a file that will be created as part of the processing of this command. This file stores your responses when this argument is used in conjunction with the --saveResponse argument and provides your responses when this argument is used in conjunction with the --useResponse argument.
When you issue the agentadmin command, you can choose the --uninstall option. With the --uninstall option, you can choose the --saveResponse argument, which requires a file name be provided. The following example illustrates this command where the file name is myfile:
./agentadmin --uninstall --saveResponse myfile
Once the uninstaller has executed the preceding command successfully, the responses are stored in a state file that can be used for later runs of the uninstaller.
If desired, you can modify the state file and configure the second uninstallation with a different set of configuration parameters.
Then you can issue another command that uses the ./agentadmin --uninstall command and the name of the file that you just created with the --saveResponse argument. The difference between the previous command and this command is that this command uses the --useResponse argument instead of the --saveResponse argument. The following example illustrates this command:
./agentadmin --uninstall --useResponse myfile
With this command, the uninstallation prompts run the uninstaller in silent mode, registering all debug messages in the install logs directory.
This section demonstrates the format and use of the agentadmin command with the --listAgents option.
The following example illustrates the format of the agentadmin command with the --listAgents option:
./agentadmin --listAgents
No arguments are currently supported with the agentadmin command when using the --listAgents option.
Issuing the agentadmin command with the --listAgents option provides you with information about all the configured web agents on that machine. For example:
The following are the details for agent Agent_001 :- Apache 2.2 Web Server Config Directory: /usr/local/apache2/conf
Notice that the agentadmin program provides unique names, such as Agent_001, for all web agents that protect the same instance of a deployment container, in this case Apache HTTP Server 2.2. Each name uniquely identifies the web agent instance.
The string “Agent” in Agent_00x is configurable. You can change this string by editing the following file: PolicyAgent-base/config/AMToolsConfig.properties
This section demonstrates the format and use of the agentadmin command with the --agentInfo option.
The following example illustrates the format of the agentadmin command with the --agentInfo option:
./agentadmin --agentInfo AgentInstance-Dir
The following argument is supported with the agentadmin command when using the --agentInfo option:
Use this option to specify which agent instance directory, therefore which agent instance such as Agent_002, you are requesting information about.
Issuing the agentadmin command with the --agentInfo option provides you with information about the web agent instance that you name in the command. For example, if you want information about a web agent instance named Agent_001 configured on Apache HTTP Server 2.2, issue the command shown in the following example:
./agentadmin --agentInfo Agent_001 The following are the details for agent Agent_001:- Apache 2.2 Web Server Config Directory: /usr/local/apache2/conf
This section demonstrates the format and use of the agentadmin command with the --version option.
The following example illustrates the format of the agentadmin command with the --version option:
./agentadmin --version
No arguments are currently supported with the agentadmin command when using the --version option.
Issuing the agentadmin command with the --version option provides you with version information for the configured web agents on that machine.
This section demonstrates the format and use of the agentadmin command with the --usage option.
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.
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. --version: Displays the version information. --listAgents: Displays details of all the configured agents. --agentInfo: Displays details of the agent corresponding to the specified agent ID. --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.
This section demonstrates the format and use of the agentadmin command with the --help option.
The following example illustrates the format of the agentadmin command with the --help option:
./agentadmin --help
No arguments are currently supported with the agentadmin command when using the --help option.
Issuing the agentadmin command with the --help option provides similar results to issuing the agentadmin command with the --usage option. Both commands provide the same explanations for the options they list. With the --usage option, all agentadmin command options are explained. With the --help option, explanations are not provided for the --usage option or for the --help option itself.
A another difference is that the --help option also provides information about the format of each option while the --usage option does not.