hvreventtool
Usage
hvreventtool [-options] hub
Description
Command hvreventtool allows you to manage events. The primary use of this command is to cancel events that are long-running or not responding. You can also add, edit, and change the state of the events using this command.
An event is a user action or activity that makes changes in the HVR Hub System. Events are maintained in the HVR_EVENT and HVR_EVENT_RESULT tables in a repository database.
Following are the different low-level states of the events:
ACTIVE - The event is in progress
CANCELED - an event was canceled by a user.
DONE - an event is completed successfully.
FAILED - an event failed to complete due to an error.
Options
This section lists and describes all options available for the hvreventtool command. For specific examples of using each option, see section Examples.
| Parameter | Description |
|---|---|
-C | Cancel an event. This sets the event state to CANCELED. This option requires option -i. |
-f | Set an event state to FAILED when editing (option -i) the event. When editing the event, the state is changed from ACTIVE to FAILED. This option requires option -i. |
-iev_id | Edit or change the event. Event ID ev_id should be specified with this option. |
-rev_responsetext | Add response text ev_responsetext for the event. This option can only be used when changing the event state using option -f. |
Examples
This section provides examples of using the hvreventtool command.
Example 1. Change event state
The following command changes the event state to FAILED.
hvreventtool -i 2018-12-12T23:59:59.000Z -f -r "Manually canceling because of..." myhub
Example 2. Cancel event
The following command cancels the event with event ID 2022-07-28T09:46:09.541Z.
hvreventtool -C -i 2022-07-28T09:46:09.541Z myhub