Plug-in Documentation

WinRS Agent Install

Overview

The WinRS Agent Install plug-in installs agents on Windows systems through WinRS. It contains a single step, which installs an agent. This step is equivalent to installing an agent from the server with the WinRS option.

Compatibility

This plug-in requires IBM UrbanCode Deploy version 6.1 or later.

This plug-in works with versions of Windows that have Windows PowerShell, including Windows Server 2003, 2008, and 2012.

The step can run on any Windows operating system. However, to install an agent on the target system, that target system must be configured as described in Installing agents on Windows through WinRS in the product documentation.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

Release Notes

Version 10

Plugin updates to install Web agents

Version 9

Compatibility update to match 6.2.7.2+ UCD server.

Version 8

Version 7

Plugin now obfuscates WinRS service password.

Version 6

Fixes APAR PI57417. Plug-in now checks the agent settings for acceptance of self signed certificates.

Steps

Process steps in the WinRS Agent Install plug-in

WinRS Agent Install

Install agent to remote machine using WinRS

Before you can run this step, you must configure the target system as described in Installing agents on Windows through WinRS in the product documentation.

Input properties for the WinRS Agent Install step
Name Type Description Required
Agent Host String The hostname or IP address of the machine to install an agent to. Yes
Agent Name String The name that the agent should show up as in IBM UCD. Yes
Installation Directory String The directory that the agent should be installed to. Yes
Java Home String The directory that java is pre-installed to. Yes
Mutual Authentication Boolean Use mutual authentication? Yes
Password Password The password of the machine to install an agent to. Yes
Proxy Host String The hostname of any proxy between the agent and IBM UCD server No
Proxy Port String The JMS Port of any proxy between the agent and IBM UCD server No
Server Host String The hostname of the IBM UCD server Yes
Server Port String The JMS Port the server listens on Yes
Temporary Directory String The directory that should be used for a temporary workspace. Yes
Username String The username of the machine to install an agent to. Yes