test text

Searching the Help

To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.

Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.

Words and Phrases

Search for Example Results

A single word cat Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

A phrase.

You can specify that the search results contain a specific phrase.

"cat food" (quotation marks)

Topics that contain the literal phrase "cat food" and all its grammatical variations.

Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Using Boolean Operators

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Operations Manager i10.62

Tool Execution Web Service Interface
- Tool Execution Web Service request reference

Develop > Web Service Interfaces > Tool Execution Web Service Interface > Tool Execution Web Service request reference

Tool Execution Web Service request reference

Request reference

The Tool Execution web service interface supports the following requests:

Request	Request Type	MA Web Service Action
`/tool_execution`	`POST`	Retrieve the list of tools applicable for the specified CI(s) or event(s).
`/tool_execution/preparation`	`POST`	For a specified tool and CI(s) or event(s), retrieve the parameters to be filled out by the user, and create an execution context in the backend (valid for 10 minutes).
`/tool_execution/execution_preview/<contextId>`	`POST`	Preview what would be executed, based on the parameters that the user has filled in.
`/tool_execution/execution/<contextId>`	`POST`	Execute the tool.
	`DELETE`	Cancel the tool execution for all affected nodes.
	`GET`	Retrieve the tool execution status for all affected CIs.
`/tool_execution/execution/<contextId>/<resultID>`	`DELETE`	Cancel the tool execution for a single CI.
	`GET`	Retrieve the tool execution status of a single CI.

XML 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.

Get a contextID:

POST – https://<server>:<port>/opr-web/rest/10.11/tool_execution/preparation

Input:

<tool_preparation xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <tool_id>
  <ci_ids>
    <ci_id>
    <!-- mandatory; multiple ci_id-tags can be used.-->
  <ci_origin>

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <id>
   <!-- the newly created context ID -->
   <tool_ref>
      <id>
      <target_id>
      <label>
      <description>
      <tool_type>
      <has_user_parameter>
      <requires_run_as_user>
      <name>
      <ci_type>
   <tool_execution_result_ref>
      <id>
      <!-- the newly created reference ID for a single target CI -->
      <execution_host>
      <tool_command>
      <tool_execution_state>

Execute a tool:

POST - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextId>

Input:

<tool_execution xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
</tool_execution>

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <id>
   <tool_ref>
      <id>
      <target_id>
      <label>
      <description>
      <tool_type>
      <has_user_parameter>
      <requires_run_as_user>
      <name>
      <ci_type>
   </tool_ref>
   <user_parameters/>
   <run_as_username>
   <tool_execution_result_ref>
      <id>
      <execution_host>
      <tool_command>
      <tool_execution_state>

Retrieve execution status for all concerned CIs:

GET - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextId>

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <id>
   <tool_ref>
      <id>
      <target_id>
      <label>
      <description>
      <tool_type>
      <has_user_parameter>
      <requires_run_as_user>
      <name>
      <ci_type>
   <run_as_username>
   <tool_execution_result_ref>
      <id>
      <execution_host>
      <tool_command>
      <tool_execution_state>
      <started>
      <started_text>
      <finished>
      <finished_text>

Retrieve execution status for a single CI:

GET - https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextId>/<resultID>

<tool_execution_result xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <id>
   <tool_ref>
      <id>
      <target_id>
      <label>
      <description>
      <tool_type>
      <has_user_parameter>
      <requires_run_as_user>
      <name>
      <ci_type>
   <execution_host>
   <tool_command>
   <user_parameters/>
   <run_as_username>
   <tool_execution_state>
   <started>
   <started_text>
   <finished>
   <finished_text>
   <executed_in_context_of>
      <entry>
         <key>
         <value>
   <output>
   <result_code>

For a given tool and CI(s) or event(s), retrieve the parameters to be filled out by the user, and create an execution context in the backend (valid for 10 minutes):

GET - https://<server>:<port>/opr-web/rest/10.11/tool_execution/preparation

Input (when specifying CI IDs):

<tool_preparation xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <tool_id>
  <ci_ids>
    <ci_id>
    <!-- mandatory; multiple ci_id-tags can be used.-->
  <ci_origin>

Input (when specifying event IDs):

<tool_preparation xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <tool_id>
  <event_ids>
    <event_id>
    <!-- mandatory; multiple event_id-tags can be used.-->
  <ci_origin>
<!--  mandatory; has one of the following values: event_related_ci, event_node, or event_source_ci  -->

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <id>
   <tool_ref>
      <id>
      <target_id>
      <label>
      <description>
      <tool_type>
      <has_user_parameter>
      <requires_run_as_user>
      <name>
      <ci_type>
   <user_parameters>
      <entry>
         <key>
         <value>
      <entry>
         <key>
         <value>
      <entry>
         <key>
         <value>

Retrieve a list of tools applicable for a given CI:

POST – https://<server>:<port>/opr-web/rest/10.11/tool_execution

Input:

<tool_query xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <ci_ids>
      <ci_id>
     <!-- mandatory; multiple ci_id-tags can be used.-->

Output:

<tool_list xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <id>
   <tools_for_ci>
      <tool_ref>
         <id>
         <target_id>
         <label>
         <description>
         <tool_type>
         <has_user_parameter>
         <requires_run_as_user>
         <name>
         <ci_type>
      <tool_ref>
         <id>
         <target_id>
         <label>
         <description>
         <tool_type>
         <has_user_parameter>
         <requires_run_as_user>
         <name>
         <ci_type>
      <tool_ref>
         <id>
         <target_id>
         <label>
         <description>
         <tool_type>
         <has_user_parameter>
         <requires_run_as_user>
         <name>
         <ci_type>

Retrieve a list of tools applicable for a given event (specified by ID):

POST – https://<server>:<port>/opr-web/rest/10.11/tool_execution

Input:

<tool_query xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <event_ids>
    <event_id>
    <!-- mandatory; multiple ci_id-tags can be used.-->

Output:

<tool_list xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <id>
    <tools_for_event_related_ci>
      <!—Only appears if there is at least one tool associated with related CI of the specified event -->
      <tool_ref>
        <!-- Information for one or multiple tools – like above -->
      <tools_for_event_node>
        <!—Only appears if there is at least one tool associated with the node on which the related CI of the event is hosted-->
      <tool_ref>
        <!-- Information for one or multiple tools – like above -->
      <tools_for_event_source_ci>
        <!—Only appears if there is at least one tool associated with the source CI of the event -->
      <tool_ref>
        <!-- Information for one or multiple tools – like above -->

Preview what would be executed based on the parameters the user has filled in:

POST – https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution_preview/<contextID>

<tool_execution xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<user_parameters>
<entry>
<key>
<value>

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <id>
   <tool_ref>
      <id>
      <target_id>
      <label>
      <description>
      <tool_type>
      <has_user_parameter>
      <requires_run_as_user>
      <name>
      <ci_type>
   <user_parameters>
      <entry>
         <key
         <value>
   <run_as_username>
   <tool_execution_result_ref>
      <id>
      <execution_host>
      <tool_command>
      <tool_execution_state>

Cancel tool execution for all affected nodes:

POST – https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextID>

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <id>
   <tool_ref>
      <id>
      <target_id>
      <label>
      <description>
      <tool_type>
      <has_user_parameter>
      <requires_run_as_user>
      <name>
      <ci_type>
   <user_parameters>
      <entry>
         <key>
         <value>
      <entry>
         <key>
         <value>
   <tool_execution_result_ref>
      <id>
      <execution_host>
      <tool_command>
      <tool_execution_state>
      <started>
      <started_text>

Cancel execution for a single CI:

POST – https://<server>:<port>/opr-web/rest/10.11/tool_execution/execution/<contextID>/<resultID>

Output:

<tool_execution_context xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <id>
   <tool_ref>
      <id>
      <target_id>
      <label>
      <description>
      <tool_type>
      <has_user_parameter>
      <requires_run_as_user>
      <name>
      <ci_type>
   <user_parameters>
      <entry>
         <key>
         <value>
      <entry>
         <key>
         <value>
   <tool_execution_result_ref>
      <id>
      <execution_host>
      <tool_command>
      <tool_execution_state>
      <started>
      <started_text>

Send Help Center feedback

We welcome your comments!

To open the configured email client on this computer, open an email window.

Otherwise, copy the information below to a web mail client, and send this email to ovdoc-asm@hpe.com.

Help Topic ID:

Product:

Topic Title:

Feedback: