Runbook AI (Add-on)
The Runbook AI (Add-on) is designed for both BigFix Runbook AI administrators and end users who are working towards the resolution of IT support tickets. Its primary purpose is to help BigFix administrators to easily monitor the health of their servers and initiate well-informed recovery actions with specialized Runbooks AI.
- Introduction
  This guide provides you with an overview of BigFix Runbook AI and its features and benefits. It also provides an architectural overview and talks about various configurations and end user activities in brief.
- Pre-requisites guide
  This guide provides instructions to install the prerequisites required for BigFix Runbook AI. This includes the installation of MongoDB and Solr for both HA (High Availability) and non-HA modes as well as generation of certificates for authentication and authorization purposes.
- Installation Guide
  This guide provides instructions to install BigFix Runbook AI. It includes the pre-installation and the installation procedures for BigFix Runbook AI. This guide also provides summary material about additional servers and optional post- installations and references to the other documents for detailed information.
- Configuration Guide
  This guide instructs on how to install and configure BigFix Runbook AI. These instructions also include the configuration procedures for the product.
- User Guide
  This guide introduces you to the key concepts of BigFix Runbook AI and describes how to use the product. It provides an overview of the end-user interface and instructions to perform different tasks. This guide is intended for the BigFix Runbook AI end-users working towards resolution of IT support tickets.
- API Guide
  BigFix Runbook AI API guide provides documentation and instructions on how to use its application programming interface (API), including details on the functions, parameters, and endpoints available for developers to interact with the API.
  - Push APIs
  - GET APIs to retrieve data dumped from above APIs
    GET APIs are used to retrieve data that has been dumped by other APIs.
  - Runbook Status Update API
    - UpdateRunbookStatus
      The UpdateRunbookStatus API is used to update the status of a runbook. The API URL, authentication type, and method type vary depending on the API version being used (V1.0, V1.1, or V2.0). The input JSON includes parameters such as TicketNumber, RbaInteractionId, RbaStatusCode, RbaStatusMessage, and optional values Option1-Option4. The output JSON includes fields like statusCode, status, message, and result, which provide information about the status update.
  - Custom Script Execution API
    The Custom Script Execution API allows for the execution of Python or PowerShell scripts through the API. It provides a URL for executing the script, authentication type, method type, input JSON format, and output format.
  - Authentication Using OAuth2.0
    The API is used to generate an OAuth token for authentication in BigFix Runbook AI APIs. The token is obtained by making a POST request to the specified API URL with the required parameters. The generated token can then be used to access various BigFix Runbook AI APIs by including it in the Authorization header of the API requests.
- Fixlet Repository Guide
  This document provides detailed list of out-of-box fixlets available within BigFix Runbook AI. This information is intended for administrators and users authorized for configuring use cases / fixlets within BigFix Runbook AI, which works in conjunction with HCL Bigfix engine.
- Integration Guide
  This guide provides instructions to enable integrations with various ITSM and Runbook Automation tools, while configuring BigFix Runbook AI.
- Lab Manual
  This lab manual provides infrastructure administrators, installation and configuration administrators, and end users with detailed instructions on how to install, configure, and use BigFix Runbook AI. It is divided into modules, each containing an introduction and lab exercises. The manual also references additional servers, post-installation steps, and other documents for more information.
- Troubleshooting Guide
  This guide provides instructions to troubleshoot some of the commonly occurring issues along with the resolution steps. This information is intended for administrators responsible for installing, configuring, and supporting BigFix Runbook AI product.
- Abbreviations
  A list of abbreviations and their expansions.

Runbook Status Update API