Java Agents 2024.9

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]

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:

  • 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, agentadmin runs in non-interactive mode.

    --saveResponse

    Save all the supplied responses in a response file specified by file-name.

--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]

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:

  • 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, agentadmin runs in non-interactive mode.

    --saveResponse

    Save all the supplied responses in a response file specified by file-name.

--custom-install, --custom

Installs a new agent instance, specifying advanced configuration options.

Usage: agentadmin --custom-install [--useResponse | --saveResponse file-name]

--useResponse

Run in silent mode by specifying all the responses in the file-name file. When this option is used, agentadmin runs in non-interactive mode.

--saveResponse

Save all the supplied responses in a response file specified by file-name.

--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, agentadmin runs in non-interactive mode.

--saveResponse

Save all the supplied responses in a response file specified by file-name.

--version, -v

Displays the agent version.

Usage: agentadmin --version

--uninstallAll

Uninstalls all agent instances.

Usage: agentadmin --uninstallAll

--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 a password in clear text to encrypt.

--getEncryptKey, --getKey

Generates an agent encryption key of 40 characters long.

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

--d, -d, --decryptAgent, --decrypt

Reveals the agent password in clear text, for the agent corresponding to the specified agent-id.

Usage: agentadmin --d [agent-id]

Example: agentadmin --d Agent_001

agent-id

The agent instance. Default: Agent_001.

--decryptPassword

Decrypts the agent password, for the agent corresponding to the specified agent-id.

Usage: agentadmin --decryptPassword encrypted-password encryption-key

encrypted-password

Encrypted agent password.

encryption-key

Key used to encrypt the agent password.

--raw-encrypt

Encrypts the agent password without requiring the agent to be installed first.

Usage: agentadmin --raw-encrypt --key-file [--password-file] [--out]

--key-file

Path and name of the encryption key.

To generate a key, use agentadmin getEncryptKey or agentadmin getKey.

Required: If the key isn’t provided or is too short, an error occurs.

--password-file

File containing a password in clear text to encrypt.

Optional: If not provided, agentadmin prompts for the password.

--out

Path and name of the file containing the resulting encrypted password.

Optional: If not provided, the encrypted result is written to the console output.