Develop > Web Service Interfaces > Action Web Service Interface > Action Web Service request reference

Action Web Service request reference

The Action Web Service interface supports the following requests:

ClosedAction Service
Request Request Type Web Service Action
/direct_execution[/{executionContextID}[/{nodeSpecificResultID}]] GET

Retrieve the command status.

/<executionContextID>/<nodeSpecificResultID>

is specified: Get the detailed command status for one specific managed node.

/<executionContextID> is specified, but /<nodeSpecificResultID> is omitted: Get the overview status for all concerned managed nodes.

Note:

/<executionContextID> is required.
POST

Execute a command as specified in the posted XML data.

Note:

  • /<executionContextID> is required.
DELETE

Cancel the execution.

/<executionContextID>/<nodeSpecificResultID> is specified: Cancel the execution on a specific node.

/<executionContextID> is specified, but /<nodeSpecificResultID> is omitted: Cancel the execution on all concerned nodes with ID <execution ContextID>.
ClosedXML Structures

For more information on XML structures, see also the OMi public web service schema definitions in <OMi_HOME>/opr/api/schema/OprDataModel.xsd.

The following XML structure examples include comments to help you to tailor them to your specific uses.

Execute a command string:

POST – https://<server>:<port>/opr-web/rest/10.10/direct_execution

Input:

<direct_execution xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:\
xs="http://www.w3.org/2001/XMLSchema">
<!--wrapper element for command execution-->
  <command>
  <!-- mandatory; the command string to execute-->
  <tool_type>
  <!-- mandatory; can be om_agent_command, perl, vb_script, java_script or wsh (Windows scripting host)-->
  <!-- If set to om_agent_command, it's executed by the OM action agent (opcacta), otherwise it's executed by the built-in module (e.g. for perl) from the OM monitor agent (opcmona)-->.
  <run_as_username>
  <!-- optional; execute the command as this user; by default the command is executed as the OM agent user.-->
  <!-- on Unix setting this XML tag has no impact if the OM agent doesn't run with superuser right;-->
  <!-- for Windows, the user password must be specified to switch to that user, but as opposed to in Unix, you can switch to any user.-->
  <run_as_user_password>
  <!-- optional; Windows only, password for the user to run the command as; see above-->
  <execution_hosts>
  <!-- mandatory; list of hosts to execute the command on-->
    <execution_host>
    <!-- mandatory; hostname or IP address of a managed node-->

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" x
mlns:xs="http://www.w3.org/2001/XMLSchema">
  <!-- wrapper element for the execution context-->
  <id>
  <!-- executionContextID; needed for all later calls-->
  <tool_ref>
  <!-- only relevant for tool web service, not for action web service-->
  <user_parameters/>
  <!-- only relevant for tool web service, not for action web service.-->
  <tool_execution_result_ref>
  <!-- status for a specific managed node-->
    <id>
    <!-- the <nodeSpecificResultId>; needed when later fetching result details.-->
    <execution_host>
    <!-- the host the command is running on-->
    <tool_command>
    <!-- only available for tools of type om_agent_command. command string executed on the host-->
    <tool_execution_state>
    <!-- can be: pending (not yet started), running, canceling, canceled, failed and finished-->
    <!-- finished = successful execution-->
    <started>
    <!-- start time in long format, like 2015-09-30T13:03:56.980+02:00-->
    <started_text>
    <!-- start time in shortened human readable format, like 01:03:56 PM-->
    <finished>
    <!-- end time (if already terminated) in long format, like 2015-09-30T13:03:56.980+02:00-->
    <finished_text>
	<!-- end time in shortened human readable format, like 01:03:56 PM-->

Retrieve status overview:

GET – https://<server>:<port>/opr-web/rest/10.10/direct_execution/<executionContextID>

Same as output for the above POST call (<tool_execution_context>).

Retrieve detailed status for one node:

GET – https://<server>:<port>/opr-web/rest/10.10/direct_execution/<executionContextID>/<nodeSpecificResultId> 

<tool_execution_result xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- wrapper element for the detailed status-->
  <id>
  <!-- the nodeSpecificResultId-->
  <tool_ref>
  <!-- only relevant for tool web service, not for action web service.-->
  <execution_host>
  <!-- the host the command is running on-->
  <user_parameters/>
  <!-- only relevant for tool web service, not for action web service--> 
  <tool_command>
  <!-- only available for tools of type om_agent_command. command string executed on the host-->
  <tool_execution_state>
  <!-- can be: pending (not yet started), running, canceling, canceled, failed and finished-->
  <!-- finished = successful execution-->
  <started>
  <!-- start time in long format, like 2015-09-30T13:03:56.980+02:00-->
  <started_text>
  <!-- start time in shortened human readable format, like 01:03:56 PM-->
  <finished>
  <!-- end time (if already terminated) in long format, like 2015-09-30T13:03:56.980+02:00-->
  <finished_text>
  <!-- end time in shortened human readable format, like 01:03:56 PM-->
  <output>
  <!-- command output-->
  <result_code>
  <!-- command return code-->

Send Help Center feedback