Difference between revisions of "API events"
m |
m |
||
| Line 3: | Line 3: | ||
== Overview == | == Overview == | ||
| − | <more> | + | There are multiple ways to get events into Veloopti. |
| + | # Using the veloopti-event.exe program | ||
| + | # Using a web post | ||
| + | |||
| + | === Using the veloopti-event.exe program === | ||
| + | This method allows you to create a Veloopti event using the veloopt-event.exe program. This program comes with every agent. | ||
| + | |||
| + | ==== Usage ==== | ||
| + | |||
| + | {| class="wikitable" | ||
| + | ! Parameter | ||
| + | ! Description | ||
| + | |- | ||
| + | | /severity=<severity> | ||
| + | | can be expressed as /sev | ||
| + | Specifies the severity of the event. The following severities are supported: information, warning, critical and | ||
| + | matching shortened versions. | ||
| + | e.g. | ||
| + | /sev=info | ||
| + | /severity warning | ||
| + | |- | ||
| + | | /short_description="<short description>" | ||
| + | | can be expressed as /short | ||
| + | Specifies the short description of the event. This argument is limited to 80 characters and will be truncated if more are supplied. | ||
| + | This argument will need to quoted as it will probably contain spaces. | ||
| + | e.g. | ||
| + | /short_description="Greater than 100 emails are in the deferred queue" | ||
| + | /short "Greater than 100 emails are in the deferred queue" | ||
| + | |- | ||
| + | | /long_description="<long description>" | ||
| + | | Set Long Description | ||
| + | |- | ||
| + | | /application=<Alias> | ||
| + | | Set the application alias | ||
| + | |- | ||
| + | | /itil=<classification> | ||
| + | | Set ITIL Classification | ||
| + | |- | ||
| + | | /key="<event key>" | ||
| + | | Set Message Key | ||
| + | |- | ||
| + | | /node_id="<event source node id>" | ||
| + | | Set Event Source Node Id | ||
| + | |- | ||
| + | | /property="<name>:<value>" | ||
| + | | Add Property | ||
| + | |- | ||
| + | | /add_help="<help text>" | ||
| + | | Add Help Text | ||
| + | |- | ||
| + | | /close | ||
| + | | Set Close | ||
| + | |- | ||
| + | | /help | ||
| + | | Display command line usage help | ||
| + | |- | ||
| + | | /info | ||
| + | | Display detailed command line usage and examples | ||
| + | |- | ||
| + | | /version | ||
| + | | Display command version information | ||
| + | |} | ||
| + | |||
| + | ==== Alias mappings ==== | ||
| + | The Alias directs the event to the correct application. | ||
| + | |||
| + | To create an alias you need a role that has the Global ''Rename Application'' or Application "Manage Alias" permission. From the application view click on the '''more option''' menu item and select '''Rename application'''. From this dialogue box fill in the Alias that you want to use for the application. | ||
| + | |||
| + | |||
| + | ==== Examples ==== | ||
| + | |||
| + | veloopti-event.exe /severity=warning /short_description="Testing event " /long_description="This is the long description, amazing, eh?" /app=test2 | ||
| + | |||
| + | |||
| + | === Using a web post === | ||
| + | Coming soon! | ||
| + | |||
[[Category:Event Administration]] [[Category:Events]] [[Category:API]] | [[Category:Event Administration]] [[Category:Events]] [[Category:API]] | ||
Revision as of 15:12, 5 December 2018
Home > Administration > Event Administration > API events
Contents
1 Overview
There are multiple ways to get events into Veloopti.
- Using the veloopti-event.exe program
- Using a web post
1.1 Using the veloopti-event.exe program
This method allows you to create a Veloopti event using the veloopt-event.exe program. This program comes with every agent.
1.1.1 Usage
| Parameter | Description |
|---|---|
| /severity=<severity> | can be expressed as /sev
Specifies the severity of the event. The following severities are supported: information, warning, critical and matching shortened versions. e.g. /sev=info /severity warning |
| /short_description="<short description>" | can be expressed as /short
Specifies the short description of the event. This argument is limited to 80 characters and will be truncated if more are supplied. This argument will need to quoted as it will probably contain spaces. e.g. /short_description="Greater than 100 emails are in the deferred queue" /short "Greater than 100 emails are in the deferred queue" |
| /long_description="<long description>" | Set Long Description |
| /application=<Alias> | Set the application alias |
| /itil=<classification> | Set ITIL Classification |
| /key="<event key>" | Set Message Key |
| /node_id="<event source node id>" | Set Event Source Node Id |
| /property="<name>:<value>" | Add Property |
| /add_help="<help text>" | Add Help Text |
| /close | Set Close |
| /help | Display command line usage help |
| /info | Display detailed command line usage and examples |
| /version | Display command version information |
1.1.2 Alias mappings
The Alias directs the event to the correct application.
To create an alias you need a role that has the Global Rename Application or Application "Manage Alias" permission. From the application view click on the more option menu item and select Rename application. From this dialogue box fill in the Alias that you want to use for the application.
1.1.3 Examples
veloopti-event.exe /severity=warning /short_description="Testing event " /long_description="This is the long description, amazing, eh?" /app=test2
1.2 Using a web post
Coming soon!