start portlet menu bar end portlet menu bar
  • Overview
  • Documentation
  • Version history

Description

This plug-in manipulates Windows Services. On Microsoft Windows operating systems, a Windows service is a long-running executable that performs specific functions, which is designed not to require user intervention. Windows services can be configured to start when the operating system is booted and run in the background as long as Windows is running, or they can be started manually when required. This plug-in makes this easy.

The Service Control Manager plug-in is an automation-based plugin. It is used during the deployment to automate Windows Services.

 

Available Steps

  • Check If Service Exists - Checks to see if one or more windows services exists.
  • Check Service Status - Getsthe status of one or more windows services.
  • Create Service - Create a Service.
  • Delete Service - Delete one or more windows services.
  • Disable Service - Disable one or more windows services.
  • Enable Service - Enable one or more windows services.
  • Start Service - Start one or more windows services.
  • Stop Service - Stop one or more windows services.

Quick Info

Product icon

Product

HCL DevOps Deploy (HCL Launch)
Plugin type icon

Type

Plug-in
Compatibility icon

Compatibility

HCL Launch version 7.3.2.8 and later, HCL Deploy version 8.0.1.3 and later
created by icon

Created by

HCLSoftware
Website icon

Website

Microsoft Windows Services

Published Date

Last Updated

Summary

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 on 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 supports agents that are running on Microsoft Windows.

Installation

See Installing plug-ins in HCL Deploy for installing and removing plug-ins.

Version History

Plug-in history details
Version Description
12 Log4j and jettison dependency updated.
11 Add compatibility with Groovy 3.
10 Fixed APAR PH08938 - Updated collectAll to collectNested for compliancy with Groovy 2.4.15.
9 Support property file encryption.
8 Added timeout to stop service step and have it check service status before attempting to stop the service so it doesn't fail on already stopped services.
6 Update steps to handle more than one service per step using a comma-separated list of service names.
5 Added a step to check a service's status
4 Added steps for enabling and disabling services
3 Improved Windows exit code handling.
2 Added a step to check if service exists. Add option to start and stop service to wait for the service to finish operation.
1 Initial release.

Steps

Process Steps

Check If Service Exists

Checks to see if one or more services exists.

Name Type Description Required
Services String A comma-separated list of services to check for. Yes

Check Service Status

Check Service Status

Name Type Description Required
Service Name String A comma-separated list of services to check for. Yes

Create Service

Create a service.

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.

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 A comma-separated list of services to delete. Yes

Disable Service

Disable one or more services.

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.

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.

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.

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

launch-servicecontrolmanager-12.1155989.zip

Updated: 02-May-2023 07:38

Release Notes

  • Log4j and jettison dependency updated.
Download Icon DOWNLOAD

launch-servicecontrolmanager-11.1126866.zip

Updated: 23-Dec-2021 06:10 

Release Notes

  • Add compatibility with Groovy 3.
Download Icon DOWNLOAD

Related Plugins