Information

This site will undergo a brief period of maintenance on Friday, 18 December at 12:30 AM Central/12:00 PM IST. During a 30 minute window, site availability may be intermittent.

service-specific Check Services Status operation


The service-specific Check Services Status wrapper checks the status for wrappers, such as IIS Admin Service only. For example, the Check IIS Admin Service.

The input parameter for the wrapper is as follows:

The following figure shows the sample request for the service-specific Check Services Status wrapper. The request is created internally.

XML sample of the adapter request for the service-specific Check Services Status wrapper

<microsoft-exchange-request>
   <command>
       <command-name>verify-serviceStatus</command-name>
       <parameters>
           <parameter>
               <name>ServiceName</name>
               <value>IMAP4Svc</value>
           </parameter>
       </parameters>
   </command>
</microsoft-exchange-request>


The important elements of the Check Services Status wrapper are as follows:

  • command-name: Specifies the operation name for a wrapper. The value verify-serviceStatus is set for wrappers in this category.
  • name: Specifies the name of the parameter in the request. The value ServiceName is set for wrappers in this category.
  • value: Specifies the internal name of the service because each wrapper queries a particular service, this value is set appropriately within each wrapper, according to the list in the following table:


 Services verified by the individual service-specific wrappers

The following figure illustrates a sample XML response for service-specific Check Services Status wrapper.

XML sample of the adapter response for the service-specific Check Services Status wrapper

<microsoft-exchange-response>
<metadata>
<status>success</status>
</metadata>
<status>success</status>
</metadata>
<commands-output>
 <command-output>
  <metadata>
   <command>sc query IMAP4Svc</command>
    <line-count>13</line-count>
    <execution-milliseconds>3031</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 sc query
IMAP4Svc</line>
    <line index = "4">Remote application process ID: 2892</line>
    <line index = "5">SERVICE_NAME: IMAP4Svc</line>
    <line index = "6">TYPE               : 20  WIN32_SHARE_PROCESS</line>
    <line index = "7">STATE              : 4  RUNNING</line>
    <line index = "8">(STOPPABLE, PAUSABLE, ACCEPTS_SHUTDOWN)</line>
    <line index = "9">WIN32_EXIT_CODE    : 0  (0x0)</line>
    <line index = "10">SERVICE_EXIT_CODE  : 0  (0x0)</line>
    <line index = "11">CHECKPOINT         : 0x0</line>
    <line index = "12">WAIT_HINT          : 0x0</line>
    <line index = "13">Remote application exited with code: 0</line>
 </output>
</command-output>
</commands-output>
</microsoft-exchange-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Atrium Orchestrator Content 20.15.02