WindowsServiceManager

Tasks Included

Windows Service Manager - Installs and deploys a windows service or TopShelf service on a target machine or a deployment group target. This task does not copy the binaries from an agent to a target machine. Use a deployment group, or use Microsoft's file copy task to copy the binaries from an agent to the target machine.

1. Locates the service by the Service Name.
2. Stops the service.
3. If Stop process is selected and the Timeout is reached, the process of the service will be stopped.
4. If Clean binary install is selected, removes all files in the parent directory of the .exe file.
5. If Recreate service is selected, deletes the service and recreates it.
6. Starts the service.

Install and Run

After installing the Windows Service Manager extension, open a release and add the 'Windows Service Manager' task.

Task Options

Task Options for Deployment Group

1. Display name - The name of the task.
2. Deployment type - Deploying with either an Agent or a Deployment Group Target.
3. Service name - The name of the Windows Service installed on the Deployment Group Target.
4. Artifact path - The path to the Artifact that contains the Windows Service binaries.
5. Timeout - The number of seconds to wait for the service to stop.

Task Options for Agent

1. Display name - The name of the task.
2. Machines - Provide a comma separated list of machine IP addresses or FQDNs. Or provide output variable of other tasks. Eg: $(variableName).
3. Admin login - Administrator login for the target machines.
4. Password - Password for administrator login for the target machines. It can accept variable defined in Build/Release definitions as '$(passwordVariable)'. You may mark variable type as 'secret' to secure it.
5. Service name - The name of the Windows Service installed on the Deployment Group Target.
6. Artifact path - The path to the Artifact that contains the Windows Service binaries.
7. Timeout - The number of seconds to wait for the service to stop.

Advanced Task Options

1. Stop process - Stops the process if the service does not respond within the timeout.
2. Clean binary install - Removes all files inside the parent directory of the .exe file prior to copying the Artifact.
3. Recreate service - Deletes and recreates the service.

Installation Task Options

1. Install the windows service - Enables service installation.
2. Start command - Command to start the executable including arguments. Containing path is also used to Install Artifacts.
3. Run As username - The username the service should run as.
4. Run As password - The password for the Run As Username. It can accept variable defined in Build/Release definitions as '$(passwordVariable)'. You may mark variable type as 'secret' to secure it.
5. Install as a TopShelf service - Enables TopShelf installation.
6. Instance name - The name of the TopShelf instance.
7. Install arguments - The TopShelf installation arguments.

Release Notes

Version 4.4

Implemented support to set Displayname, Description and StartupType for non TopShelf services. Implemented support for Command Arguments Implemented support to install dotnet based Service Implemented Recreate service flag Fixed Permission issue (add RunAsService Permission while installation)

Version 4

Implemented support for installing TopShelf windows services.

Version 3

Implemented feature request for installing a service and resolved bug for multiple machine support.

Version 2

Resolved bug for service name matching, service name will only support exact names.

Version 1

Supports deployment groups and agents using WinRM.

Version 0

Supports deployment groups only.