Exchange 2003 actor adapter requests and responses
You use the information in this topic with the Call adapter activity to create an adapter request. For detailed instructions about how to use the Call adapter activity, see the TrueSight Orchestration Development Studio User Guide.
Sample adapter request
The following figure shows an XML sample of an adapter request for the Microsoft Exchange 2003 adapter.
Sample adapter request for the Microsoft Exchange 2003 adapter
<microsoft-exchange-request>
<command>
<command-name>verify-serviceStatus</command-name>
<parameters>
<parameter>
<name>servicename</name>
<value>MSExchangeMGMT</value>
</parameter>
<parameter>
<name>servicename</name>
<value>RESvc</value>
</parameter>
</parameters>
</command>
</microsoft-exchange-request>
<command>
<command-name>verify-serviceStatus</command-name>
<parameters>
<parameter>
<name>servicename</name>
<value>MSExchangeMGMT</value>
</parameter>
<parameter>
<name>servicename</name>
<value>RESvc</value>
</parameter>
</parameters>
</command>
</microsoft-exchange-request>
The main elements of the adapter request are:
- command-name: Specifies the operation name to invoke a particular operation. Do not provide this element explicitly; it is internally added in each of the wrappers.
- parameters: Defines all the input parameters for a command execution, each of which are provided in a <parameter> tag. An individual parameter is a combination of <name> and <value> tags.
Sample adapter response
The following figure illustrates an XML sample of the adapter response for the Microsoft Exchange 2003 adapter.
Sample adapter response for the Microsoft Exchange 2003 adapter
<microsoft-exchange-response>
<metadata>
<status>success</status>
</metadata>
<commands-output>
<command-output>
<metadata>
<command>sc query MSExchangeMGMT</command>
<line-count>13</line-count>
<execution-milliseconds>1937</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 MSExchangeMGMT</line>
<line index = "4">Remote application process ID: 6648</line>
<line index = "5">SERVICE_NAME: MSExchangeMGMT</line>
<line index = "6">TYPE : 10 WIN32_OWN_PROCESS</line>
<line index = "7">STATE : 4 RUNNING</line>
<line index = "8">(STOPPABLE, NOT_PAUSABLE, IGNORES_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>
<command-output>
<metadata>
<command>sc query RESvc</command>
<line-count>13</line-count>
<execution-milliseconds>3094</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 RESvc</line>
<line index = "4">Remote application process ID: 3116</line>
<line index = "5">SERVICE_NAME: RESvc</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>
<metadata>
<status>success</status>
</metadata>
<commands-output>
<command-output>
<metadata>
<command>sc query MSExchangeMGMT</command>
<line-count>13</line-count>
<execution-milliseconds>1937</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 MSExchangeMGMT</line>
<line index = "4">Remote application process ID: 6648</line>
<line index = "5">SERVICE_NAME: MSExchangeMGMT</line>
<line index = "6">TYPE : 10 WIN32_OWN_PROCESS</line>
<line index = "7">STATE : 4 RUNNING</line>
<line index = "8">(STOPPABLE, NOT_PAUSABLE, IGNORES_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>
<command-output>
<metadata>
<command>sc query RESvc</command>
<line-count>13</line-count>
<execution-milliseconds>3094</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 RESvc</line>
<line index = "4">Remote application process ID: 3116</line>
<line index = "5">SERVICE_NAME: RESvc</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*