agentadmin — manage OpenAM policy agent installation
agentadmin
{options}
This command manages OpenAM policy agent installations. The agentadmin command requires a Java runtime environment.
The following options are supported.
--install
Installs a new Agent instance.
Usage: agentadmin --install [--useResponse | --saveResponse
file-name
]
--useResponse
Use this option to install in silent mode by specifying all
the responses in a response specified by
file-name
. When this option is used
the installer runs in non-interactive mode.
--saveResponse
Use this option to save all the supplied responses to a response
file specified by file-name
.
--custom-install
Installs a new Agent instance
Usage: agentadmin --custom-install [--useResponse |
--saveResponse file-name
]
--useResponse
Use this option to install in silent mode by specifying all the
responses in a response specified by
file-name
. When this option is used the
installer runs in non-interactive mode.
--saveResponse
Use this option to save all the supplied responses to a response
file specified by file-name
.
--uninstall
Uninstalls an existing Agent instance.
Usage: agentadmin --uninstall [--useResponse |
--saveResponse file-name
]
--useResponse
Use this option to install in silent mode by specifying all
the responses in a response specified by
file-name
. When this option is used the
installer runs in non-interactive mode.
--saveResponse
Use this option to save all the supplied responses to a response
file specified by file-name
.
--version
Displays the version information.
--uninstallAll
Uninstalls all the agent instances.
--migrate
Migrate agent to newer version
--listAgents
Displays details of all the configured agents.
--agentInfo
Displays details of the agent corresponding to the specified agent ID.
Usage: agentadmin --agentInfo
agent-id
--agentInfo
Displays details of the agent corresponding to the specified
agent-id
.
Example: agentadmin --agentInfo agent_001
--encrypt
Encrypts a given string.
Usage: agentadmin --encrypt
agent-instance
password-file
agent-instance
Agent instance identifier. The encryption functionality requires the use of agent instance specific encryption key present in its configuration file.
password-file
File containing the password to encrypt.
--getEncryptKey
Generates an agent encryption key.
The following example installs an Apache HTTP Server 2.2 interactively,
where Apache HTTP Server has been installed under
/path/to/apache22
.
$ ./agentadmin --install ... ----------------------------------------------- SUMMARY OF YOUR RESPONSES ----------------------------------------------- Apache Server Config Directory : /path/to/apache22/conf OpenSSO server URL : http://openam.example.com:8080/openam Agent URL : http://www.example.com:80 Agent Profile name : Apache Web Agent Agent Profile Password file name : /tmp/pwd.txt ... SUMMARY OF AGENT INSTALLATION ----------------------------- Agent instance name: Agent_001 Agent Bootstrap file location: /path/to/web_agents/apache22_agent/Agent_001/config/ OpenSSOAgentBootstrap.properties Agent Configuration Tag file location /path/to/web_agents/apache22_agent/Agent_001/config/ OpenSSOAgentConfiguration.properties Agent Audit directory location: /path/to/web_agents/apache22_agent/Agent_001/logs/audit Agent Debug directory location: /path/to/web_agents/apache22_agent/Agent_001/logs/debug Install log file location: /path/to/web_agents/apache22_agent/installer-logs/audit/install.log ...