Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

HealthBot Getting Started Guide


Ready. Set. Let’s go!

Use this guide to get started with HealthBot and start monitoring the health of your network devices.


Learn About HealthBot

To learn about how HealthBot works, see the HealthBot Overview.

Get Started

The general workflow to get HealthBot up and running is as follows:

Part 1: Verify installation and initial setup

Before we get started in the HealthBot GUI, you must have:

  • HealthBot installed. See the Installation Guide for more details.
  • Network devices properly setup to stream telemetry data to the HealthBot server. See Network Device Requirements for more details on OS and configuration requirements.

Part 2: Onboard Devices and Include in Groups

Log in to the HealthBot GUI

  1. Open a browser (Chrome, Firefox, or Safari) and go to https://<machine-IP>:8080.
  2. In the login pop-up window:
    • If this is your first time logging in to HealthBot, enter the default user name and password: admin and healthbot.

      You are required to change the default password for the admin user. The password change window provides suggestions for password complexity and a strength meter to help you judge the strength of your new password.

    • If you have already changed your admin password, use the new password for this and all future logins.

  3. Click Save
  4. On successful log in, you see the Dashboard page.

Discover a Device

  1. On the left-nav bar, select Configuration > Device.
  2. Click the + button on the upper right part of the page.
  3. In the Add Device(s) window that appears, fill in the fields highlighted in red. For the Authentication section, choose the appropriate authentication type and fill in the required information. You can leave the other settings un-configured.
  4. Click Save & Deploy. A confirmation window replaces the add device window.
  5. Click Ok
  6. You should now see the device added to the Device List.
  7. (Optional) Repeat the steps above and add more devices.

Add the Device to a Device Group

  1. On the left-nav bar, click on Configuration > Device Group.
  2. Click on the + button to add a new device group.
  3. In the pop-up window that appears, fill in the following (highlighted in red) fields. You can leave the other settings un-configured:
  4. Click Save & Deploy. A confirmation window replaces the add device group window.
  5. Click Ok
  6. You should now see the group added to the Dashboard page.
  7. (Optional) Repeat the steps above to create more groups.

Part 3: Start collecting telemetry data

Review Playbooks and Rules

  1. In the left-nav bar, select the Configuration > Playbooks page.
  2. Review the list of predefined playbooks and click on any that look interesting. As you review the playbook details, make a note of any rules that look interesting.
  3. In the left-nav bar, select the Configuration > Rules page.
  4. Find one of the rules you noted above and click it. Review the details and parameters that make up the rule. The goal here is simply to get a first look at the components and parameters that make up a rule.

    You can can see that the rule is an iAgent rule and uses the ChasissFanTable from the YAML file chassis-fan.yml.

Apply Playbooks

  1. Return to the Configuration > Playbooks page. Let’s instantiate some common predefined playbooks to get started.
  2. Look to the bottom of the page and click Next to see the remaining available playbooks on page 2.
  3. Click the Apply icon (the ‘airplane’ icon) for the system-kpis-playbook.
  4. In the Run Playbook: pop-up window that appears:
    • Give the playbook an instance name.

    • In the Device Group drop-down menu, select the device group you created earlier.

  5. Click Run Instance.
  6. On the Playbooks page, click the caret beside the system-kpis-playbook. In the drop-down you should see your playbook instance instantiated and running. Note that it may take a few moments.
  7. Now click Previous to go back to the first page, and repeat the steps above to instantiate an instance of the interface-kpis-playbook.

Part 4: Monitor devices

Monitor Device Health

  1. In the left-nav bar, select the Dashboard page.
  2. The carousel across the top of the page shows multiple widget icons. You can double click any of these icons to activate the widget in the lower part of the page. Scroll the carousel left or right to find the Device Group List, Devices List, and the Device Health icons. Double click each of these to activate them in the Dashboard.
  3. In the left-nav bar select Monitor > Device Group Health.
  4. On the Device Group Health page, select your device group from the blue pull-down menu.
  5. In the Select Device field, select your device.
  6. You should now be on the Device Group Health page, with information being displayed about the device. This page shows the rules above in action; as they collect data it appears here as status information for the device. The Tile View shows status information grouped by topic area. For example, the system.cpu tile shows CPU status information, with each colored block representing an aspect of the CPU’s status.
  7. Hover your mouse over the system.cpu tile blocks and review the information.
  8. Now click the system.cpu heading. Notice that the Table View at right is reduced to show just the system.cpu entries.
  9. To monitor events over time, click Timeline View at the upper-left of the screen (under the device name). This view shows real-time and past occurrences of events flagged with the health status of minor (yellow) or major (red). Hover your mouse over a colored line or dot and review the information.

You are now up and running with Contrail HealthBot! Feel free to continue exploring the GUI further as you wish.

What’s Next