Installing agents remotely

You can install agents by using the IBM® UrbanCode Deploy web application.

Before you begin

Ensure that each computer where you are installing an agent has Java™ Runtime Environment (JRE) or Java Development Kit (JDK) version 7 or greater.

If the target computer has an IBM JRE or JDK, update the JRE or JDK to version 7.0.0 SR4 with the specified service refresh (SR) level or a later service refresh level:

To install agents on Windows systems with this feature, ensure that the WinRS agent is configured on the System Settings page. See System settings.

About this task

You can install an agent by specifying its target location, or install an agent that was previously discovered with the agent discovery feature. You can install several agents simultaneously, and, by using agent installation property sheets, ensure that all agents share basic parameters.

You can install agents only on UNIX or Windows systems with this feature. For other systems, including z/OS®, see Installing agents from the command line.

Procedure

  1. Click Resources > Agents.
  2. To install an agent, perform one of the following actions:
    • If you know the target host, click Install New Agent.
    • If you want to install an agent that was discovered with the agent discovery feature, click the Install Agent action for the agent. Discovered agents have the Installable status.
    For information about the agent discovery feature, see Discovering agents automatically.
    Install Agent action for an agent with the Installable status
  3. Specify the operating system that is used by the target host:
    • Select SSH if the target system is UNIX.
    • Otherwise, select WinRS.
    Note: If you are installing a discovered agent, this step is skipped because the system type is automatically determined during discovery.
  4. Enter the host name or IP address of the system where you want to install the agent in the Target Hosts* field. To specify multiple entries, type each one on a separate line. On Windows, agent names are the same as the host names or IP addresses that you enter.
    Note: If you are installing a discovered agent, this step is skipped because the host or IP address is automatically determined during discovery.
  5. If you are installing the agent on UNIX, specify the following parameters:
    1. Enter the SSH port address of the target system in the SSH Port*.
    2. Check the Use Public Key Authentication check box if you want to use public key authentication instead of a password.
    3. Enter a name for the agent in the Agent Name* field.
      Note: If you enter multiple hosts in the Target Hosts* field, the agent name is appended with a number. The number is incremented for each host after the first one. For example, if you enter my_agent as the agent name and specify three hosts, the name of the agent for the first host is my_agent, the name of the agent for the second host is my_agent1, and the name of the third agent is my_agent2. Host names are processed from top of the list to bottom.
  6. Enter the name of the user with appropriate permissions on the target host in the Username* field.
  7. Enter the password that is associated with the user in the Password* field.
  8. Select an agent installation property sheet from the Agent Installation Properties list, or use New to create a property sheet. Agent installation property sheets are templates that can be saved and used to install agents. You can create any number of agent installation property sheets. The agent installation properties are listed in the following table:
    Table 1. Remote agent installation properties
    Field Description
    Name Name of the agent installation property sheet.
    Description Property sheet description.
    Agent Dir Directory on the target where the agent is installed.
    Java Home Path Path to Java on the target. In many cases, you can use the value of the JAVA_HOME system variable.
    Temp Dir Path Path to the directory that is used during installation for temporary files.
    Server Host Host name or IP address of the IBM UrbanCode Deploy server or agent relay to which the agent connects. If the agent is connecting to clustered servers, specify the host name of the load balancer.
    Server Port The port that is used by the IBM UrbanCode Deploy or agent relay to connect to the agent. The default value is 7918 for the server, and 7916 for the agent relay.
    Proxy Host Host name or IP address of the agent relay, if used.
    Proxy Port HTTP port of the agent relay, if used. Default value is 20080.
    Auto Start If you want to install the agent as a service, check Auto Start to run the agent automatically when Windows starts. Windows only.
    Service Name If the agent is installed as a service, enter a name for the agent service. Windows only.
    Service User If the agent is installed as a service, enter a user name that has appropriate permission to run a service. Windows only.
    Service Password If the agent is installed as a service, enter the password that is associated with the service user. Windows only.
  9. Check Assign Team if you want to assign the agent to a team.
    The parameters that are used to assign an agent to a team
    1. Click Add .
    2. Select the team to which you want to assign the agent from the Team list.
    3. Select the agent role from the Role list. For information about teams, see Assigning teams directly to items
  10. Click Save when you are done.

Results

Remotely installed agents start running automatically. If a remotely installed agent stops running, it must be restarted on the host system.

Feedback