service-specific Start Services, Stop Services, and Restart Services operations - Documentation for BMC Atrium Orchestrator Content 20.14.02
Emily Bell Service-specific wrappers (for example, Start IIS Admin Service, Stop IIS Admin Service and Restart IIS Admin Service wrappers), start, stop, and restart IIS Admin services only that particular service.
The input parameters for the service-specific Start Services, Stop Services, and Restart Services wrappers are listed in the following table:
Input parameter for the service-specific Start Services, Stop Services, and Restart Services wrappers
Element | Definition | Required |
|---|---|---|
| Specifies the name of the adapter to handle the request Default value: MicrosoftExchangeActorAdapter | No |
The following figure shows a sample of a service-specific adapter request for the Start Services wrapper:
XML sample of an adapter request for the service-specific Start Services wrapper
<microsoft-exchange-request> <command> <command-name>start-service</command-name> <parameters> <parameter> <name>servicename</name> <value>MSExchangeSA</value> </parameter> </parameters> </command>
</microsoft-exchange-request>The following figure shows a sample of a service-specific adapter request for the Restart Services wrapper:
XML sample of an adapter request for the service-specific Restart Services wrapper
<microsoft-exchange-request> <command> <command-name>restart-service</command-name> <parameters> <parameter> <name>servicename</name> <value>MSExchangeSA</value> </parameter> </parameters> </command>
</microsoft-exchange-request>The following figure shows a sample of a service-specific adapter request for the Stop Services wrapper:
XML sample of an adapter request for the service-specific Stop Services wrapper
<microsoft-exchange-request> <command> <command-name>stop-service</command-name> <parameters> <parameter> <name>servicename</name> <value>MSExchangeSA</value> </parameter> </parameters> </command> </microsoft-exchange-request>The important elements in the request are:
<command-name>: Specifies the operation name for the: start-service, stop-service, or restart-service.<name>: Specifies the name of the parameter in the request: servicename<value>: Specifies the internal name of the service to perform an action. This value is set appropriately within each wrapper, according to the list in the following table:
Services verified by the individual service-specific wrappers
Services that are specific | Service in <value> tag of a request |
|---|---|
Start, Stop, Restart IIS Admin Service | IISADMIN |
Start, Stop, Restart Microsoft Exchange Event Service | MSExchangeES |
Start, Stop, Restart Microsoft Exchange IMAP4 Service | IMAP4Svc |
Start, Stop, Restart Microsoft Exchange Information Store Service | MSExchangeIS |
Start, Stop, Restart Microsoft Exchange Management Service | MSExchangeMGMT |
Start, Stop, Restart Microsoft Exchange MTA Stacks Service | MSExchangeMTA |
Start, Stop, Restart Microsoft Exchange POP3 Service | POP3Svc |
Start, Stop, Restart Microsoft Exchange Routing Engine Service | RESvc |
Start, Stop, Restart Microsoft Exchange System Attendant Service | MSExchangeSA |
Start, Stop, Restart Microsoft Search Service | MSSEARCH |
Start, Stop, Restart Network News Transfer Protocol Service | NntpSvc |
Start, Stop, Restart Print Spooler Service | Spooler |
Start, Stop, Restart Simple Mail Transfer Protocol Service | SMTPSVC |
The following figure shows a sample of a service-specific adapter response for the Start Services wrapper:
XML sample of an adapter response for the service-specific Start Services wrapper
<microsoft-exchange-response> <metadata> <status>success</status> </metadata> <commands-output> <command-output> <metadata> <command>net start MSExchangeSA</command> <line-count>7</line-count> <execution-milliseconds>5516</execution-milliseconds> <exit-code>0</exit-code> <status>success</status> </metadata> <output> <line index="1">Attempting to connect to remote host...</line> <line index="2">Initialising rctrlx server component...</line> <line index="3">Executing remote application: cmd /c net start
MSExchangeSA</line> <line index="4">Remote application process ID: 9008</line> <line index="5">The Microsoft Exchange System Attendant
service is starting.</line> <line index="6">The Microsoft Exchange System Attendant
service was started successfully.</line> <line index="7">Remote application exited with code: 0</line> </output> </command-output> </commands-output>
</microsoft-exchange-response>
The following figure illustrates the service-specific adapter response for the Restart Services wrapper.
XML sample of the adapter response for the service-specific Restart Services wrapper
<microsoft-exchange-response>
<metadata> <status>success</status>
</metadata> <status>success</status>
</metadata> <commands-output> <command-output> <metadata> <command>net stop MSExchangeSA /y</command> <line-count>18</line-count> <execution-milliseconds>65000</execution-milliseconds> <exit-code>0</exit-code> <status>success</status> </metadata> <output> <line index = "1">Attempting to connect to remote host...</line> <line index = "2">Initialising rctrlx server component...</line> <line index = "3">Executing remote application: cmd /c net stop
MSExchangeSA /y</line> <line index = "4">Remote application process ID: 4148</line> <line index = "5">The following services are dependent on the
Microsoft Exchange System Attendant service.</line> <line index = "6">Stopping the Microsoft Exchange System Attendant
service will also stop these services.</line> <line index = "7">Microsoft Exchange MTA Stacks</line> <line index = "8">Microsoft Exchange Event</line> <line index = "9">Microsoft Exchange Information Store</line> <line index = "10">The Microsoft Exchange MTA Stacks
service is stopping......</line> <line index = "11">The Microsoft Exchange MTA Stacks
service was stopped successfully.</line> <line index = "12">The Microsoft Exchange Event
service is stopping..</line> <line index = "13">The Microsoft Exchange Event
service was stopped successfully.</line> <line index = "14">The Microsoft Exchange Information Store
service is stopping.............</line> <line index = "15">The Microsoft Exchange Information Store
service was stopped successfully.</line> <line index = "16">The Microsoft Exchange System Attendant
service is stopping....</line> <line index = "17">The Microsoft Exchange System Attendant
service was stopped successfully.</line> <line index = "18">Remote application exited with code: 0</line> </output> </command-output>
<command-output>
<metadata> <command>net start "Microsoft Exchange System Attendant"</command> <line-count>7</line-count> <execution-milliseconds>11531</execution-milliseconds> <exit-code>0</exit-code> <status>success</status> </metadata> <output> <line index = "1">Attempting to connect to remote host...</line> <line index = "2">Initialising rctrlx server component...</line> <line index = "3">Executing remote application: cmd /c net start
"Microsoft Exchange System Attendant"</line> <line index = "4">Remote application process ID: 6092</line> <line index = "5">The Microsoft Exchange System Attendant
service is starting..</line> <line index = "7">Remote application exited with code: 0</line> </output> </command-output> <command-output>
<metadata> <command>net start "Microsoft Exchange Information Store"</command> <line-count>7</line-count> <execution-milliseconds>42391</execution-milliseconds> <exit-code>0</exit-code> <status>success</status> </metadata> <output> <line index = "1">Attempting to connect to remote host...</line> <line index = "2">Initialising rctrlx server component...</line> <line index = "3">Executing remote application: cmd /c net start
"Microsoft Exchange Information Store"</line> <line index = "4">Remote application process ID: 5260</line> <line index = "5">The Microsoft Exchange Information Store
service is starting..............</line> <line index = "6">The Microsoft Exchange Information Store
service was started successfully.</line> <line index = "7">Remote application exited with code: 0</line> </output> </command-output>
<command-output> <metadata> <command>net start "Microsoft Exchange Event"</command> <line-count>7</line-count> <execution-milliseconds>10828</execution-milliseconds> <exit-code>0</exit-code> <status>success</status> </metadata> <output> <line index = "1">Attempting to connect to remote host...</line> <line index = "2">Initialising rctrlx server component...</line> <line index = "3">Executing remote application: cmd /c net start "Microsoft Exchange Event"</line> <line index = "4">Remote application process ID: 6516</line> <line index = "5">The Microsoft Exchange Event service is starting.</line> <line index = "6">The Microsoft Exchange Event
service was started successfully.</line> <line index = "7">Remote application exited with code: 0</line> </output> </command-output> <command-output>
<metadata> <command>net start "Microsoft Exchange MTA Stacks"</command> <line-count>7</line-count> <execution-milliseconds>25578</execution-milliseconds> <exit-code>0</exit-code> <status>success</status> </metadata> <output> <line index = "1">Attempting to connect to remote host...</line> <line index = "2">Initialising rctrlx server component...</line> <line index = "3">Executing remote application: cmd /c net start
"Microsoft Exchange MTA Stacks"</line> <line index = "4">Remote application process ID: 5700</line> <line index = "5">The Microsoft Exchange MTA Stacks
service is starting.......</line> <line index = "6">The Microsoft Exchange MTA Stacks
service was started successfully.</line> <line index = "7">Remote application exited with code: 0</line> </output> </command-output> </commands-output>
</microsoft-exchange-response>
The following figure shows a sample of a service-specific adapter response for the Stop Services wrapper:
XML sample of an adapter response for the service-specific Stop Services wrapper
<microsoft-exchange-response> <metadata> <status>success</status> </metadata> <commands-output> <command-output> <metadata> <command>net stop MSExchangeSA /y</command> <line-count>7</line-count> <execution-milliseconds>5797</execution-milliseconds> <exit-code>0</exit-code> <status>success</status> </metadata> <output>
<line index="1">Attempting to connect to remote host...</line> <line index="2">Initialising rctrlx server component...</line> <line index="3">Executing remote application: cmd /c net stop
MSExchangeSA /y</line> <line index="4">Remote application process ID: 9060</line> <line index="5">The Microsoft Exchange System Attendant
service is stopping.</line> <line index="6">The Microsoft Exchange System Attendant
service was stopped successfully.</line> <line index="7">Remote application exited with code: 0</line> </output> </command-output> </commands-output>
</microsoft-exchange-response>