generic Start Services, Stop Services, and Restart Services operations

The Start Services, Stop Services, and Restart Services wrappers are used to start, stop, and restart Microsoft Exchange Server services, and they support all the Microsoft Exchange services. The wrappers are located as follows:

v2003 > Exchange Services Management > Start Services directory to start services
v2003 > Exchange Services Management > Stop Services directory to stop services
v2003 > Exchange Services Management > Restart Services directory to restart services

Note

The dependent services stop or restart, for the Stop Services and the Restart Services wrapper.

The generic services supported by Start Services, Stop Services and Restart Services wrappers are listed in the following table.

Services verified by the Start services, Stop Services, and Restart Services wrapper

The input parameters for the Start Services, Stop Services, and Restart Services wrappers are listed in the following table:The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

The following figure shows a sample of a generic adapter request for the Start Services wrapper:

XML sample of an adapter request for the generic 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 generic adapter request for the Restart Services wrapper:

XML sample of an adapter request for the 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 generic adapter request for the Stop Services wrapper:

XML sample of an adapter request for the 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

The following figure shows a sample of a generic adapter response for the Start Services wrapper:

XML sample of an adapter response for the 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 generic adapter response for the Restart Services wrapper.

XML sample of the generic adapter response for the 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 = "6">The Microsoft Exchange System Attendant
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 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 generic adapter response for the Stop Services wrapper:

XML sample of an adapter response for the 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>

generic Start Services, Stop Services, and Restart Services operations

On this page