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 |
|
- Event Synchronization Web Service Interface
- Forward events and event changes from OPR client
- Synchronize event changes back from external client
- Event attributes that support back synchronization
- Event update: Logfile Adapter examples
- Event change creation: Logfile Adapter examples
- Event update to event_list example
- Event Submit Examples
- Event change creation for event_change_list examples
- Event synchronization web service troubleshooting
Event change creation: Logfile Adapter examples
You can submit event changes with an event change creation. The HTTP method in this case is POST, and the expected payload for the LogfileAdapter is an OprEventChange
. The examples in this section show sample XML payloads for each supported update. If a Groovy script is not configured for the connected server, the Event Synchronization Web Service expects an OprEventChange
object. Each of the samples that follow represent an OprEventChange object.
The Event Synchronization Web Service supports sending multiple properties in a single payload. The following examples each show just one changed property, with the exception of the last sample, which shows two changed properties (see Change Multiple Properties in One Call).
The examples use an event ID of 531d2673-683f-429f-a742-b8680ee01a76
. Change this event ID to the ID of the specific event for which you wish to create a change object. The correct HTTP method for the creation of an event change is the POST method.
You can also use the event change list web service to get examples of event change objects. You can access the event change list web service using this URL:
https://<server.example.com>/opr-web/rest/9.10/event_change_list
An example call for an event change creation is shown below.
The following sample call for an event change creation is for a connected server named logger
with password set to Password1
, and attempts to create an event change for an event with ID 531d2673-683f-429f-a742-b8680ee01a76
. For an event change, the event ID must be passed in the payload, and is not part of the URL. The sample call looks like this:
RestWsUtil -create create.xml-url "https://<server.example.com>/opr-gateway/rest/9.10/synchronization/event_change/<event id>" -username logger -password Password1 -verbose
The samples that follow show possible XML payloads for the call. The payloads are contained in the create.xml
file referenced in the call to the RestWsUtil
command-line utility.
The Event Synchronization Web Service supports only insert and update operations for annotations. The delete operation is not supported.
Example: Insert an Annotation
Here is a sample payload showing an annotation insert:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <annotation_property_change> <property_name>annotation</property_name> <current_value xsi:type="xs:string">This is a new Annotation.</current_value> <change_operation>insert</change_operation> </annotation_property_change> </changed_properties> </event_change>
Example: Update an Annotation
Here is a sample payload showing an update to an annotation with the ID of 1c108839-9584-45f4-93ab-798bf49797c7
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <annotation_property_change> <property_name>annotation</property_name> <annotation_id>1c108839-9584-45f4-93ab-798bf49797c7</annotation_id> <current_value xsi:type="xs:string">This is an updated Annotation.</current_value> <change_operation>update</change_operation> </annotation_property_change> </changed_properties> </event_change>
The Event Synchronization Web Service supports only the set or unset operations for the cause of an event. Insert, update, or delete operations are not supported. You set or unset the cause on the symptom event.
Example: Set the Cause of an Event
Here is a sample payload showing how to set the cause of an event to be the event with the ID of 9915e504-f5a2-471a-ab98-6184a7382d32
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <string_property_change> <property_name>cause</property_name> <current_value xsi:type="xs:string">9915e504-f5a2-471a-ab98-6184a7382d32</current_value> </string_property_change> </changed_properties> </event_change>
Example: Unset the Cause of an Event
Here is a sample payload showing how to unset the cause of an event:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <string_property_change> <property_name>cause</property_name> <current_value xsi:type="xs:string"/> </string_property_change> </changed_properties> </event_change>
The Event Synchronization Web Service supports only insert and update operations for custom attributes. The delete operation is not supported.
Example: Insert a Custom Attribute
Here is a sample payload showing how to insert a custom attribute, custom_attribute
, with the value Some CA value
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <custom_attribute_property_change> <property_name>custom_attribute</property_name> <key>TestCA</key> <current_value xsi:type="xs:string">Some CA value</current_value> <change_operation>insert</change_operation> </custom_attribute_property_change> </changed_properties> </event_change>
Example: Update a Custom Attribute
Here is a sample payload showing how to update a custom attribute, custom_attribute
, with the value Some updated CA value
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <custom_attribute_property_change> <property_name>custom_attribute</property_name> <key>TestCA</key> <current_value xsi:type="xs:string">Some updated CA value</current_value> <change_operation>update</change_operation> </custom_attribute_property_change> </changed_properties> </event_change>
The Event Synchronization Web Service supports only the set or unset operations for the description of an event. Insert, update, or delete operations are not supported.
Example: Set the Description
Here is a sample payload showing how to set the description in an event change creation to Some description of the event
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <string_property_change> <property_name>description</property_name> <current_value xsi:type="xs:string">Some description of the event. </current_value> </string_property_change> </changed_properties> </event_change>
Example: Unset the Description
Here is a sample payload showing how the description in an event change creation is unset:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <string_property_change> <property_name>description</property_name> <current_value xsi:type="xs:string"/> </string_property_change> </changed_properties> </event_change>
The only operation that is possible on the state of an event is to give the state a new value. Insert, update, or delete operations are not applicable for event state changes.
The possible values for the state of an event are: open
, in_progress
, resolved
, closed
.
Example: Set the State
Here is a sample payload showing how the state in an event change creation is set to the value in_progress
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <state_change> <property_name>state</property_name> <current_value xsi:type="xs:string">in_progress</current_value> </state_change> </changed_properties> </event_change>
The only operation that is possible on the priority of an event is to give the priority a new value. Insert, update, or delete operations are not applicable for priority changes.
You can set the priority to one of the following values: none
, lowest
, low
, medium
, high
, highest
.
Example: Set the Priority
Here is a sample payload showing how the priority in an event change creation is set to low
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <priority_property_change> <property_name>priority</property_name> <current_value xsi:type="xs:string">low</current_value> </priority_property_change> </changed_properties> </event_change>
The only operation that is possible on the severity of an event is to give the severity a new value. Insert, update, or delete operations are not applicable for severity changes.
You can set the severity to one of the following values: critical
, major
, minor
, warning
, normal
.
Example: Set the Severity
Here is a sample payload showing how the severity in an event change creation is set to normal
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <severity_property_change> <property_name>severity</property_name> <current_value xsi:type="xs:string">normal</current_value> </severity_property_change> </changed_properties> </event_change>
The Event Synchronization Web Service supports only the set or unset operations for the solution of an event. Insert, update, or delete operations are not applicable for solution changes.
Example: Set a Solution
Here is a sample payload showing how the solution in an event change creation is set to Some solution to the event
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <string_property_change> <property_name>solution</property_name> <current_value xsi:type="xs:string">Some solution to the event.</current_value> </string_property_change> </changed_properties> </event_change>
Example: Unset a Solution
Here is a sample payload showing how the solution in an event change creation is unset:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <string_property_change> <property_name>solution</property_name> <current_value xsi:type="xs:string"/> </string_property_change> </changed_properties> </event_change>
The Event Synchronization Web Service supports only the set or unset operations for the title of an event. Insert, update, or delete operations are not applicable for title changes.
Example: Set the Title
Here is a sample payload showing how the title in an event change creation is set to Some title for the event
:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <string_property_change> <property_name>title</property_name> <current_value xsi:type="xs:string">Some title for the event.</current_value> </string_property_change> </changed_properties> </event_change>
Example: Unset the Title
Here is a sample payload showing how the title in an event change creation is unset:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <string_property_change> <property_name>title</property_name> <current_value xsi:type="xs:string"/> </string_property_change> </changed_properties> </event_change>
The Event Synchronization Web Service supports sending multiple properties in a single payload. Here, we show two changed properties.
Example: Set the Title and Description
Here is a sample payload to set the event title and description in a single update call:
<event_change xmlns="http://www.hp.com/2009/software/opr/data_model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <event_ref> <target_id>531d2673-683f-429f-a742-b8680ee01a76</target_id> </event_ref> <changed_properties> <string_property_change> <property_name>title</property_name> <current_value xsi:type="xs:string">Some title for the event.</current_value> </string_property_change> <string_property_change> <property_name>description</property_name> <current_value xsi:type="xs:string">Some description for the event.</current_value> </string_property_change> </changed_properties> </event_change>
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: