4.16.4 Startup setting for the OS service
Function
This plug-in sets the OS startup type on the Windows execution target server according to the specified startup method.
The following explains the meaning of an important term used in this document:
- OS service
To distinguish from services executed in JP1/AO, Windows services are generically referred to as OS services.
OS services specified for an OS service name (common.serviceName property) have a name and a service display name displayed in Name when you click Control Panel, Administrative Tools, and then Services.
For the OS service activation method (common.serviceStartup property), specify delayed-auto (delayed activation), auto (auto activation), demand (manual activation), or disabled.
The prerequisite server for this plug-in is as follows:
- Execution target server
This server is used as the target for executing this plug-in.
Scripts in this plug-in perform the following processing:
- Checking that wild cards; or asterisks (*), question marks (?), and commas (,), are not used in the OS service name specified in the OS service name (common.serviceName property)
- Execution of the following command
sc config (sc GetDisplayName "OS-service-name(common.serviceName-property)") start= "OS-service-activation-method(common.serviceStartup-property)"
For details of the sc config, sc GetDisplayName command, visit the Microsoft library Web site.
Use situation
The command can be used to set the OS service activation method.
Prerequisites
For the latest support status of the following items, see the Release notes: Prerequisite product within the system, prerequisite products on the execution target server, and running OS for prerequisite products on the execution target server.
Prerequisite product within the system:
- JP1/Automatic Operation 11-00 or later
Prerequisite products within the execution target server:
None
Running OS on the execution target server:
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
Conditions of using the execution target server:
None
Cautions
(1) Do not use a character string containing a double quotation mark (") or a single quotation mark (') in a plug-in property. If you use such a character string, this plug-in will terminate abnormally.
(2) The connected user defined for the agentless connection destination requires access permission for the operation target OS service.
(3) When you specify an OS service name (common.serviceName property), use its full name. You cannot use a partial match or a wild card.
Version
02.00.01
Plug-in tags
Control OS,Windows
Plug-in name displayed in the task log
osSetServiceStartup
Return code
0: Normal
21: Error (invalid environment) Command cannot be found (error detected in the plugin script)
27: Error (check task logs for the nature of error)
41: Error (error detected in plugin) Missing property (error detected in plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
common.serviceName |
Service Name |
Name of the service for which you want to change the startup type. |
-- |
Input |
R |
|
common.serviceStartup |
OS service activation method |
Specify the method of activating Windows services by using one of delayed-auto (delayed activation), auto (auto activation), demand (manual activation), and disabled. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |