Integration with Zenoss

BigFix Runbook AI integrates with Zenoss for Incident Management (IM) by creating and managing the required IM data sources. Before creating or configuring the data source, ensure that the organization has been set up.

This scenario is applicable when the ITSM tools is not available in the client environment and event management tool and BigFix Runbook AI are tightly integrated directly. The event data or the probable root cause identified flows to BigFix Runbook AI which then performs the appropriate action for resolution.

To create a data source, perform the following steps:

  • On the main menu bar, click Actions tabManage Data Source.
  • The Create Data Source page appears with the following tabs:
  • Organization
  • Data Source
  • Fetch Data Configuration
  • Release Rules Configuration
  • Close Rules Configuration (Optional – applicable only when the issue closure status update is managed by BigFix Runbook AI directly instead of RBA tool)
  • InProgress Rules Configuration (Optional – applicable only when the issue’s in progress status updates is managed by BigFix Runbook AI directly instead of RBA tool)
Figure 1. Figure 342 – Create Data Source
  • On the Organization tab,
  • Select the Organization Name from the dropdown.
  • Select the Module as Event Management, since we are configuring this data source for pulling the event data.
  • Select the Service as Zenoss Tool as we are configuring the data source for Zenoss
  • Select the Integration Type as REST, since we will be integrating through REST APIs.
  • Check Is ticket Closure Managed by BigFix Runbook AI job if you want BigFix Runbook AI to manage the issue closure updates instead of the RBA tool. In this scenario, an additional tab Close Rules Configuration will be activated for providing further details, steps for which are mentioned later.
  • Check “Is ticket InProgress Managed by BigFix Runbook AI job” if you want BigFix Runbook AI to manage the issue’s in progress status updates instead of the RBA tool. In this scenario, an additional tab “InProgress Rules Configuration” will be activated for providing further details, steps for which are mentioned later.
  • Click Next.
Figure 2. Figure 343 – Create Data Source (cont.)
  • On the Data Source tab:
  • Type the new data source in the Name field.
  • Select the Timezone to specify the time zone of the selected data source.
  • Select Timestamp to view the present data with date and time.
  • Select Analysis Enabled if user wants to analyze the data retrieved from the data source.
  • Click Next.
Figure 3. Figure 344 – Create Data Source (cont.)
  • On the Fetch Data Configuration tab, type in the details as per the environment.
  • In the Connection Details section, enter the following details:
  • URL – Type the URL which contains the placeholders that display the parameters based on the applied clause such as the number of records to be fetched, query type, date on which the data is fetched, and the order by and so on. It is dependent on the URL or API provided by the tool.
  • Sample URL - https://<zenossURL>/cz0/zport/dmd/evconsole_router
  • Authentication Type - Select one of the Authentication Types from NoAuth / Basic / Windows
  • Selection of Basic / Windows requires you to enter -
  • User Id
  • Password
  • Request Method - Select Request Method as POST from the drop-down.
  • Proxy Required - Check Proxy Required, if the environment needs access to content from data sources outside the firewall.
  • Click on Test Connection to check accessibility of URL from service. Testing the connection is not mandatory, you can still create Data source.
Figure 4. Figure 345 – Create Data Source (Connection Details)
  • Request Header Parameters – Please enter the request header parameters as required.
  • Request Body - As request method selected earlier is POST, please enter the body of URL. A sample response is mentioned below.

Request Body –

{"action": "EventsRouter","method": "query",

"data": [{

"keys": ["evid", "summary", "eventState", "severity", "eventClass", "ownerid", "firstTime", "lastTime", "count", "eventClassKey", "message"],

"params": {

"eventState": [0, 1], "severity": [5],

"excludeNonActionables": false,

"firstTime": "#firstTime# TO #lastTime#","eventClass": []},

"limit": 200,

"sort": "firstTime",

"dir": "ASC",

"start": 0,

"uid": "/cz0/zport/dmd"

}],

"type": "rpc",

"tid": 2

}

Figure 5. Figure 346 – Create Data Source (Connection Details)
  • Response Body – In this section, please enter the output of URL query for one of the incidents in JSON format. A sample response is mentioned below.

Response Body –

{

"result": {

"totalCount": 1,

"events": [

{

"count": 1,

"firstTime": 1600874287.072,

"severity": 5,

"evid": "0242ac11-000c-b913-11ea-fdaffba5ea6f",

"eventClassKey": "",

"summary": "10.1.140.244 | manageIP: 10.1.140.244",

"eventState": "New",

"ownerid": null,

"eventClass": {

"text": "/App",

"uid": "/zport/dmd/Events/App"

},

"lastTime": 1600874287.072,

"message": "10.1.140.244"

}

],

"success": true,

"asof": 1601266658.118566

}

}

  • After entering the response, click Extract Keys to add the parameters in the Mandatory Parameter Mapping section.
  • Mandatory Parameter Mapping – Please map the mandatory parameters to the respective values as mentioned in the screenshot below:
Table 1. Table 70– Sample Mandatory Parameter Mapping
Key Value Type Value
TicketNumber JSON.Keys result.0.evid
Summary JSON.Keys result.events.0.summary
Description JSON.Keys result.events.0.message
CreationDate JSON.Keys result.events.0.firstTime
StatusCode JSON.Keys result.events.0.eventState
ResolvedDate JSON.Keys result.events.0.lastTime
LastModifiedDate JSON.Keys result.events.0.lastTime
Figure 6. Figure 347 – Mandatory Parameter Mapping
  • If you need to add Optional parameters, click Add Response Parameter to add more parameters. For our purpose, we will be adding a couple of extra parameters, as mentioned below, as we need them in the later section.
Table 2. Table 71– Sample Optional Parameters
Key Value Type Value
Col1 JSON.Keys result.0.evid
Figure 7. Figure 348 – Optional Parameter Mapping
  • Click Next to proceed to Release Rules Configuration.
  • On Release Rules Configuration tab, type in the details as per the requirement.
  • In the Connection Details section, enter the following details:
  • URL – Type the URL of the selected service type to release the ticket. It contains the placeholders that display the parameters based on the applied clause and is dependent on the URL or API provided by the tool.
  • Sample URL - https://<zenossurl>/cz0/zport/dmd/evconsole_router
  • Authentication Type – Please enter the information in line with the Authentication type configured for fetching data configuration previously.
  • Request Method – Select Request Method as POST from the drop-down.
  • Proxy Required – Check Proxy Required, if the environment needs access to content from data sources outside the firewall.
  • Click on Test Connection to check accessibility of URL from service. Testing the connection is not mandatory, you can still create Data source.
Figure 8. Figure 349 – Release Rules Configuration (Connection Details)
  • Request Header Parameters – Please enter the request header parameters as required.
  • Request Body – In this section, please enter the request body in JSON format. A sample request is mentioned below.

Request Body –

{

"action": "EventsRouter",

"method": "write_log",

"data": [{

"evid": "#evid#",

"message": "#message#"

}],"tid":2

}

Figure 9. Figure 350 – Release Rules Configuration (Request Body)
  • Response Body – In this section, please enter the response body in JSON format. A sample response is mentioned below.

Response Body –

{

"uuid": "0fc0b53f-8fba-4aa1-a561-1fef7ecc53fb",

"action": "EventsRouter",

"result": {

"success": true

},

"tid": 2,

"type": "rpc",

"method": "write_log"

}

Figure 10. Figure 351 – Release Rules Configuration (Response Body)
  • On Close Rules Configuration tab, type in the details as per the requirement. Check Same as Release if similar configurations as mentioned in “Release Rules Configuration” are required, else proceed ahead.
  • In the Connection Details section, enter the following details:
  • URL – Type the URL of the selected service type to release the ticket. It contains the placeholders that display the parameters based on the applied clause and is dependent on the URL or API provided by the tool.
  • Sample URL - https://<zenossurl>/cz0/zport/dmd/evconsole_router
  • Authentication Type – Please enter the information in line with the Authentication type configured for fetching data configuration previously.
  • Request Method – Select Request Method as POST from the drop-down.
  • Proxy Required – Check Proxy Required, if the environment needs access to content from data sources outside the firewall.
  • Click on Test Connection to check accessibility of URL from service. Testing the connection is not mandatory, you can still create Data source.
Figure 11. Figure 352 – Release Rules Configuration (Connection Details)
  • Request Header Parameters – Please enter the request header parameters as required.
  • Request Body – In this section, please enter the request body in JSON format. A sample request is mentioned below.

Request Body –

{

"action": "EventsRouter",

"method": "close",

"data": [{

"evids": "#evids#"

}],"tid":2

}

Figure 12. Figure 353 – Release Rules Configuration (Request Body)
  • Response Body – In this section, please enter the response body in JSON format. A sample response is mentioned below.

Response Body –

{

"uuid": "ff0352d5-01aa-4eba-b6e4-0798039d6cc4",

"action": "EventsRouter",

"result": {

"data": {

"updated": 31,

"total": 3670

},

"success": true

},

"tid": 2,

"type": "rpc",

"method": "acknowledge"

}

Figure 13. Figure 354 – Release Rules Configuration (Response Body)
  • On InProgress Rules Configuration tab, type in the details as per the requirement. Check Same as Release if similar configurations as mentioned in “Release Rules Configuration” are required, else proceed ahead.
  • In the Connection Details section, enter the following details:
  • URL – Type the URL of the selected service type to release the ticket. It contains the placeholders that display the parameters based on the applied clause and is dependent on the URL or API provided by the tool.
  • Sample URL - https://<zenossurl>/cz0/zport/dmd/evconsole_router
  • Authentication Type – Please enter the information in line with the Authentication type configured for fetching data configuration previously.
  • Request Method – Select Request Method as POST from the drop-down.
  • Proxy Required – Check Proxy Required, if the environment needs access to content from data sources outside the firewall.
  • Click on Test Connection to check accessibility of URL from service. Testing the connection is not mandatory, you can still create Data source.
Figure 14. Figure 355 – Release Rules Configuration (Connection Details)
  • Request Header Parameters – Please enter the request header parameters as required.
  • Request Body – In this section, please enter the request body in JSON format. A sample request is mentioned below.

Request Body –

{

"action": "EventsRouter",

"method": "acknowledge",

"data": [{

"evids": "#evids#"

}],"tid":2

}

Figure 15. Figure 356 – Release Rules Configuration (Request Body)
  • Response Body – In this section, please enter the response body in JSON format. A sample response is mentioned below.

Response Body –

{

"uuid": "ff0352d5-01aa-4eba-b6e4-0798039d6cc4",

"action": "EventsRouter",

"result": {

"data": {

"updated": 31,

"total": 3670

},

"success": true

},

"tid": 2,

"type": "rpc",

"method": "acknowledge"

}

Figure 16. Figure 357 – Release Rules Configuration (Response Body)
  • Click Submit to add the data source.