Plug-in Documentation

Microsoft Windows Services

Overview

The Microsoft Windows Services plug-in includes steps to manage Windows Services. Use this plug-in to start, stop, create, and get status on services that are running on a computer that is running the Microsoft Windows operating system.

To add the Microsoft Windows Services plug-in steps to processes, click System Utility > Windows > ServiceControlManager in the step palette of the process editor.

Compatibility

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

This plug-in supports agents running on Microsoft Windows.

Installation

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

Steps

Process steps in the Service Control Manager plug-in

Check If Service Exists

Checks to see if one or more services exists.

Input properties for the Check If Service Exists step
Name Type Description Required
Services String A comma-separated list of services to check for. Yes

Check Service Status

Gets the status of one or more services.

Input properties for the Check Service Status step
Name Type Description Required
Service Name String A comma-separated list of services to check for. Yes

Create Service

Create a service.

Input properties for the Create Service step
Name Type Description Required
Arguments String A newline-separated list of arguments to add to the sc.exe call. For example: /start=\nauto\n/binpath=\nC:\temp\n/ No
Service Name String The name of the service to create. Yes

Delete Service

Delete one or more services.

Input properties for the Delete Service step
Name Type Description Required
Arguments String A newline-separated list of arguments to add to the sc.exe call. For example: /start=\nauto\n/binpath=\nC:\temp\n/ No
Services String A comma-separated list of services to delete. Yes

Disable Service

Disable one or more services.

Input properties for the Disable Service step
Name Type Description Required
Arguments String A newline-separated list of arguments to add to the sc.exe call. For example: /error=\nsevere\n/binpath=\nC:\temp\n/ No
Services String A comma-separated list of services to disable. Yes

Enable Service

Enable one or more services.

Input properties for the Enable Service step
Name Type Description Required
Arguments String A newline-separated list of arguments to add to the sc.exe call. For example: /error=\nsevere\n/binpath=\nC:\temp\n/ No
Service Name String A comma-separated list of services to enable. Yes
Start Type Enumeration:

  • boot
  • system
  • auto
  • demand
  • delayed-auto
Start-up type for the service. Yes

Start Service

Start one or more services.

Input properties for the Start Service step
Name Type Description Required
Arguments String A newline-separated list of arguments to add to the sc.exe call. For example: /start=\nauto\n/binpath=\nC:\temp\n/ No
Services String A comma-separated list of services to start. Yes
Wait for Started Boolean When selected, the step waits for the service to run before proceeding. No

Stop Service

Stop one or more services.

Input properties for the Stop Service step
Name Type Description Required
Arguments String A newline-separated list of arguments to add to the sc.exe call. For example: /start=\nauto\n/binpath=\nC:\temp\n/ No
Services String A comma-separated list of services to stop. Yes
Set Timeout String If you enter a value for Set Timeout, the step terminates the service after the specified time interval. Specify the value in milliseconds. No
Wait for Stopped Boolean When selected, the step waits for the service to stop before proceeding. No