Applicable for ENA v23.0 P01 upwards.
To configure the Entuity integration with Moogsoft
How Entuity incidents are mapped to Moogsoft
Entuity incidents can be pushed from Entuity to Moogsoft AIOps using the Moogsoft RESTful services.
To configure the Entuity integration with Moogsoft:
- In Moogsoft:
- Navigate to Integrations > Install UI.
- Create a default Webhook LAM and set a name for the integration.
This establishes the Moogsoft endpoint for Entuity to connect with, together with the user and password for the Moogsoft client that uses basic authentication. You do not need to make changes to the other editable dialogs.
- In Entuity:
- Navigate to the enutity_home
/etcdirectory. - Use the
Moofsoft-example.cfgfile in this directory to create a file calledMoogsoft.cfg. -
Update the 'default' section or add a named 'section' to the file that lists key-value pairs for port, host, path, user and password.
These values are available in the Integrations > Install UI for the Moogsoft Webhook LAM you created in step 1:[default] port-443 host=endpoint.moogsoft.io path=/events/webhook_ena user=Webhook pass=password
Note,userandpassattributes are not required if using the 'Send to Moogsoft Queue' action, as they can be entered as parameters in the action itself.
Note, if the configuration file that specifies these connection properties is not namedMoogsoft.cfgand/or is not located in the entuity_home/etcdirectory, then you must define the actual location of the file in theeventEnginesection of the Entuitystartup_XX.cfgconfiguration file.. You can do this by specifying the JVM property, property,'moog.cfg', within theeventEnginestart command:-Dmoog.cfg=${ENTUITY_HOME}${FPS}etc${FPS}YourMoogsoftConfig.cfg
- Navigate to the enutity_home
- In the Entuity UI, set up the Entuity incident trigger to forward Entuity incidents to Moogsoft:
- Click Main Menu and then Administration.
- On the Administration page, click Event Administration.
- On the Event Administration page, click the Incidents tab.
- Click Edit Global Triggers at the bottom of the window to open the Edit Global Triggers window.
- Click Add to open the Create Trigger window.
- Complete the Name and Description fields, as appropriate, and ensure that the enabled checkbox is selected.
- In the Action Steps section, click Add to open the Add Action window.
- In the Type dropdown field, select 'Send to Moogsoft' or, from Entuity v23 P01 upwards, the 'Send to Moogsoft Queue' action step to forward incidents.
As of Entuity v23.0 P01 upwards, the 'Send to Moogsoft' action forwards incidents directly to Moogsoft, while the 'Send to Moogsoft Queue' action forwards incidents to Moogsoft through a queue from the Message Broker. Sending through a queue helps prevent communication or connection errors during the forwarding process, as messages remain in the queue until successfully acknowledged by the target endpoint. A message queue log file is also created when using the 'Send to Moogsoft Queue' action. For more information on message queues, see this article. - For Entuity to connect with Moogsoft using values specified in a section other than the
[default]section in theMoogsoft.cfgfile from step iii, set the action stepcnameparameter value to the section name in theMoogsoft.cfgfile, without [] brackets. - If you selected selected the 'Send to Moogsoft Queue' action step (Entuity v23.0 P01 upwards), choose whether to execute callback actions by optionally using the 'Response Callback' action. Do one of the following.
- If you want a 'Response Callback' action executed when incidents are sent to Moogsoft:
- Keep the
callback = 'Response Callback'parameter in the 'Send to Moogsoft Queue' action step. - Create a Moogsoft-specific 'Response Callback' action from the Actions tab of the Event Administration page, and define which action to execute upon receiving a response from Moogsoft.
- Return to the 'Send to Moogsoft Queue' action step from the Incidents tab of the Event Administration page, and enter the name of the newly created 'Response Callback' action in the
callback = 'Response Callback'parameter.
- Keep the
- If no 'Response Callback' action is required, set the value to null without quotes.
- If you want a 'Response Callback' action executed when incidents are sent to Moogsoft:
- Click OK, and then click OK again on the Edit Global Triggers window.
-
In a multi-server configuration of Entuity, confirm that some information about the consolidation server is available in the main section of the Entuity
entuity.cfgfile on all servers.
This is required, as the data is included in the payload that is sent to Moogsoft for reverse communication:consolidation_server_name=server-name consolidation_server_web_port=X consolidation_server_web_ssl=true or false -
In Moogsoft:
- Set up the data to be used for Moogsoft deduplication by navigating to Integrations > Alert Noise Reduction in the UI.
- Edit the Signature Editor by removing the existing default entries and replacing them with the word 'signature' (without quotation marks).
The value of the signature field in the payload that is sent to Moogsoft will be used for their deduplication analysis.
Note, this setting will be required until the proprietary Entuity LAM is available, at which point it will already be set as the default signature field.
How Entuity incidents are mapped to Moogsoft:
The below tables describe how Entuity incidents are mapped to Moogsoft JSON fields:
| Field Name | Field Description | Example or Actual Value |
|---|---|---|
| agent_location | name and port of the Entuity server that is forwarding the incidents to Moogsoft. | <my_entuity_server>:443 |
| agent_time | incident's last updated timestamp in unixtime seconds. | For example: 1542195721 |
| description | static string identifier of this incident. | For example: 1542195721 |
| external_id | static numeric identifier of this incident, e.g. its type, plus Entuity server ID, to ensure it matches the IDs on the Entuity server from which it originated. | For example: 1542195721 |
| severity |
severity of the incident, using Entuity's raw values, as follows:
|
For example: 1542195721 |
| source | Entuity managed device (IP address or name) where the Entuity incident's source object exists. | For example: 1542195721 |
| source_id | Entuity object identifier for the device that is specified in source, plus the Entuity server that manages this device. Entuity server identifiers are required to uniquely identify objects in a multi-server environment. | For example: 1542195721 |
| class | class of incidents being passed | "Network" |
| type | type of the incident's source. | For example: 1542195721 |
| signature |
a string consisting of IDs concatenated using '::'. The originating Entuity server ID string will only be present at the end of the signature. The signature allows identity of the same type of incident occurring on the same source object: <source_id>::<component_id>::<external_id> |
For example: 1542195721 |
| Custom Field Name | Field Description | Example or Actual Value |
|---|---|---|
| callback_url | Callback URL for launching Entuity in context of the incident. | For example: 1542195721 |
| source_detail | incident's details. | For example: 1542195721 |
| incident_source_id |
unique identifier of the source of the incident, plus the Entuity server ID (to ensure uniqueness across Entuity servers). Note, this will identify the actual object that is the source of the incident, which may or may not be a device. It may also be a sub-object, e.g. a port, processor, fan, etc. source_object_identifier::server_identifier |
For example: 1542195721 |
| incident_source_description |
string description of the source of the incident. Note, this will describe the actual object that is the source of the incident, which may or may not be a device. It may also be a sub-object, e.g a port, processor, fan, etc. |
For example: 1542195721 |
| incident_instance_id | unique ID to identify a specific instance of an incident. This is required when calling Entuity's RESTful API to close an incident. | For example: 1542195721 |
| incident_server_id | unique ID to identify the Entuity server where the incident originated, and necessary in a multi-server deployment. This is required when calling Entuity's RESTful API to close an incident. | For example: 1542195721 |
| state | incident's current state, one of Open, Closed or Expired. | For example: 1542195721 |
Comments
0 comments
Please sign in to leave a comment.