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.

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

Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Web Service Interfaces
- Reference information for all web services
- Action Web Service Interface
- Downtime Web Service Interface
- Event Synchronization Web Service Interface
- Event Web Service Interface
- Monitoring Automation Web Service Interface
- Status Web Service Interface
- Tool Execution Web Service Interface
- User Management Web Services Interface
Tool Execution Web Service Interface
The REST- based Tool Execution web service enables integrators to access the following functionality from an external application:
-
Request a list of preconfigured tools that can be applied to a specific CI or in the context of an event.
-
Execute a tool on a set of nodes.
-
Cancel a tool execution.
- Retrieve the results of a tool execution.
For more information on tools, see Tools. For information on the opr-tool command-line interface, see opr-tool Command-Line Interface.

Your entry point to the web service interface is the service document, using the following base URL and syntax:
|
|
<serviceURL> |
The URL of the Tool Execution web service:
where |
<request> |
The service request. For a complete list and syntax of possible service requests, see Tool Execution Web Service request reference. |
List of Services in the Service Document
OPR Tool Web Services |
URL |
---|---|
Tool Web Service preview POST |
|
Tool Web Service POST | GET | DELETE |
|
Tool Web Service query tools POST |
|
Tool Web Service preparation POST |
|
Tool Web Service details GET | DELETE |
|

To be able to access the Tool Execution web service, a user needs to be assigned a role with the correct level of Tools (Execution) permission. This permission can be accessed in the Operations Console category of the permission section of a role. For more information on permissions, see Users, Groups, and Roles.

Error handling for the Tool Execution web service is as follows:
HTTP error codes:
- HTTP error code 403: authorization problems
- HTTP error code 409: requested hosts are not in the RTSM or no CIs match the requirements
- HTTP error code 4xx (other than 403, 409): any form of communication problems with the OMi backend
- HTTP code 200: at least one requested host is in the RTSM and meets the requirements
Individual return codes per requested host (HTTP code always 200):
- Return code -404: requested host is not in the RTSM or the CI does not meet the requirements
- Return code -500: communication problem with the requested host
- Return code 0: execution succeeded
- Other return codes (for example, 1): error code from the command to be executed
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: