agentadmin command
The agentadmin command manages Java Agent installation. It
requires a Java runtime environment. The command supports the following options:
--install
Installs a new agent instance.
Usage: agentadmin --install [--useResponse | --saveResponse file-name] [--acceptLicence]
Before installation, shut down the agent container. If a service on an agent URL is responding, the installer stops with an error.
When the command is used without options, the installation process prompts for the following information:
-
Confirmation that you have read and accepted the software license agreement.
-
Information about the container installation.
-
The URL of the AM instance. The agent confirms that it can log in to AM by using the profile name and password provided during installation. If unsuccessful, the installation stops with an error.
-
The URL of the agent instance. The agent confirms that it can access the host and port of the URL. If the port is busy, it prompts the user to stop the container.
-
The agent profile name in AM.
-
The AM realm containing the agent profile.
-
The path to the file containing the agent password.
--useResponse-
Run in silent mode by specifying all the responses in the file-name file. When this option is used,
agentadminruns in non-interactive mode. --saveResponse-
Save all the supplied responses in a response file specified by file-name.
--acceptLicense-
Suppress the license agreement prompt. Specifying this option indicates that you have read and accepted the terms stated in the license.
View the license agreement at
/path/to/java_agents/agent_type/legal-notices/Forgerock_License.txt.
--forceInstall
Installs a new agent instance, without checking the AM URL or agent URL.
Use this option in deployments with load balancers or reverse proxies, where the URL of the agent and AM can be concealed.
Usage: agentadmin --forceInstall [--useResponse | --saveResponse file-name] [--acceptLicence]
Before installation, shut down the agent container. If a service on an agent URL is responding, the installer stops with an error.
When the command is used without options, the installation process prompts for the following information:
-
Confirmation that you have read and accepted the software license agreement.
-
Information about the container installation.
-
The URL of the AM instance. The agent confirms that it can log in to AM by using the profile name and password provided during installation. If unsuccessful, the installation stops with an error.
-
The URL of the agent instance. The agent confirms that it can access the host and port of the URL. If the port is busy, it prompts the user to stop the container.
-
The agent profile name in AM.
-
The AM realm containing the agent profile.
-
The path to the file containing the agent password.
--useResponse-
Run in silent mode by specifying all the responses in the file-name file. When this option is used,
agentadminruns in non-interactive mode. --saveResponse-
Save all the supplied responses in a response file specified by file-name.
--acceptLicense-
Suppress the license agreement prompt. Specifying this option indicates that you have read and accepted the terms stated in the license.
View the license agreement at
/path/to/java_agents/agent_type/legal-notices/Forgerock_License.txt.
--custom-install, --custom
Installs a new agent instance, specifying advanced configuration options.
Usage: agentadmin --custom-install [--useResponse | --saveResponse file-name] [--acceptLicence]
--useResponse-
Run in silent mode by specifying all the responses in the file-name file. When this option is used,
agentadminruns in non-interactive mode. --saveResponse-
Save all the supplied responses in a response file specified by file-name.
--acceptLicense-
Suppress the license agreement prompt. Specifying this option indicates that you have read and accepted the terms stated in the license.
View the license agreement at
/path/to/java_agents/agent_type/legal-notices/Forgerock_License.txt.
--uninstall, -r
Uninstalls an existing agent instance.
Usage: agentadmin --uninstall [--useResponse | --saveResponse file-name]
--useResponse-
Run in silent mode by specifying all the responses in the file-name file. When this option is used,
agentadminruns in non-interactive mode. --saveResponse-
Save all the supplied responses in a response file specified by file-name.
--listAgents, --list, -l
Displays information about all configured agents.
Usage: agentadmin --listAgents
--agentInfo, --info
Displays information about the agent corresponding to the specified agent-id.
Usage: agentadmin --agentInfo 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, --getKey
Generates an agent encryption key of 40 characters in length.
Usage: agentadmin --getEncryptKey
--key
Generates an agent encryption key of the specified length. For security, generate keys that are about 80 characters long.
Usage: agentadmin --key key-length