Use the appropriate Configuration pages from the left-nav to manage devices, device groups, and network groups. HealthBot supports both Junos devices by default and third party vendor devices with the required license installed. You must add a device to one or more device groups or create a network group before you can apply HealthBot rules and playbooks to a device. Network groups allow you to correlate health status data between multiple devices across the network. For example, you can create a network group that monitors the ping times between two or more devices and notifies you if the ping times are too high.
To add a device:
The following table describes the attributes in the Add a Device window:
Attributes | Description |
|---|---|
Name | Name of the device. Default is hostname. (Required) |
Hostname / IP Address / Range | Hostname or IP address of a single device. If you are providing a range of IP addresses, enter the IP address for the device that marks the start and end of the address range. (Required) |
System ID to use for JTI | Unique system identifier required for JTI native sensors. Junos devices use the following format: <host_name>:<jti_ip_address> When a device has dual routing engines (REs), it might send different system IDs depending on which RE is primary. You can use a regular expression to match both system IDs. |
Flow Source IPs | Enter the IP address(es) that this device uses to send NetFlow data to HealthBot. |
OpenConfig Port Number | Port number required for JTI OpenConfig sensors. The default value is 32767. |
iAgent Port Number | Port number required for iAgent. The default value is 830. |
Vendor | Vendor or supplier of the device you are using. Note: If you plan to use Cisco IOS XR devices, you must first configure the telemetry. For more information, see HealthBot Installation Requirements |
OS | Device operating system. |
SNMP Port Number | Port number required for SNMP. |
SNMP Community | Community name required for SNMP. Default is public. |
Timezone | Timezone for this device, specified as + or -hh:mm. For example, +07:00 |
Syslog Source IPs | List of IP addresses for the device sending syslog messages to HealthBot. For example, 10.10.10.23, 192.168.10.100. |
Syslog Hostnames | List of hostnames for the device sending syslog messages to HealthBot. For example, router1.example.com. |
Authentication (Required either here or at Device Group level) | |
Password | Username—Authentication
username. Password—Authentication
password. |
SSL | Server Common Name—Server name protected by the SSL certificate. CA Profile*—Choose
the applicable CA profile(s) from the drop-down list. Local Certificate*—Choose the applicable local certificate profile(s) from the drop-down
list. |
SSH | SSH Key Profile*—Choose
the applicable SSH key profile(s) from the drop-down list. Username—Authentication
username. |
*To edit or view details about saved security profiles, go to the Security page under the Settings menu in the left-nav bar.
To edit a device:
You can search and filter the device names in the table.
See Adding a Device for a description of each attribute.
To add a device group:
The following table describes the attributes in the Add a Device Group window:
Attributes | Description |
|---|---|
Name | Name of the device group. (Required) |
Description | Description for the device group. |
Devices | Add devices to the device group from the drop-down list. (Required) |
Native Ports | (Native GPB sensors only) List the port numbers on which the Junos Telemetry Interface (JTI) native protocol buffers connections are established. |
Flow Ports | (NetFlow sensors only) List the port numbers on which the NetFlow data is received by HealthBot. The port numbers must be unique across the entire HealthBot installation. |
Syslog Ports | Specify the UDP port(s) on which syslog messages are received by HealthBot. |
Retention Policy | Select a retention policy from the drop-down list for time series data used by root cause anaylsis (RCA). By default, the retention policy is 7 days. For information on how to configure a retention policy, see Configuring a Retention Policy for the Time Series Database. |
Reports | In the Reports field, select one or more health report profile names from the drop-down list to generate reports fo the device group. Reports include alarm statistics, device health data, as well as device-specific information (such as hardware and software specifications). To edit or view details about saved health report profiles, go to the System page under the Settings menu in the left-nav bar. The report profiles are listed under Report Settings. For more information, see Alarms and Notifications. |
Summarization | To improve the performance and disk space utilization of the HealthBot time series database, you can configure data summarization methods to summarize the raw data collected by HealthBot. Use these fields to configure data summarization: Time Span—The time
span (in minutes) for which you want to group the data points for
data summarization. Summarization Profiles—Choose the data summarization profiles from the drop-down list for
which you want to apply to the ingest data. To edit or view details
about saved data summarization profiles, go to the Data Summarization
Profiles page under the Settings menu in the left-nav
bar. For more information, see Configure Data Summarization. |
Ingest Frequency | Select existing Ingest Frequency Profiles to override rule or sensor frequency settings. |
Authentication(Required here or at Device level) | |
Password | Username—Authentication
user name. Password—Authentication
password. |
SSL | Server Common Name—Server name protected by the SSL certificate. CA Profile*—Choose
the applicable CA profile(s) from the drop-down list. Local Certificate*—Choose the applicable local certificate profile(s) from the drop-down
list. |
SSH | SSH Key Profile*—Choose
the applicable SSH key profile(s) from the drop-down list. Username—Authentication
username. |
Notifications |
For more information, see Alarms and Notifications. |
Logging Configuration | You can collect different severity levels of logs for the running HealthBot services of a device group. Use these fields to configure which log levels to collect: Global Log Level—From
the drop-down list, select the level of the log messages that you
want to collect for every running HealthBot service for the device
group. The level is set to error by default. Log Level for specific services—Select the log level from the drop-down list for any
specific service that you want to configure differently from the Global Log Level setting. The log level that you select for
a specific service takes precedence over the Global Log Level setting. For more information, see Logs for HealthBot Services. |
Publish | You can configure HealthBot to publish HealthBot sensor and field data for a specific device group: Destinations—Select
the publishing profiles that define the notification type requirements
(such as authentication parameters) for publishing the data. To edit or view details about saved publishing profiles, go to the System page under the Settings menu in the left-nav bar. The publishing profiles are listed under Notification Settings. Field—Select the HealthBot
rule topic and rule name pairs that contain the field data you want
to publish. Sensor—(Device group
only) Select the sensor paths or YAML tables that contain the sensor
data you want to publish. No sensor data is published by default. |
*To edit or view details about saved security profiles, go to the Security page under the Settings menu in the left-nav bar.
To edit a device group:
See Adding a Device Group for a description of each attribute.
To configure a retention policy for the time series data used for root cause analysis (RCA):
The following table describes the attributes in the Add a Retention Policy window:
Attributes | Description |
|---|---|
Name | Name of the retention policy. |
Duration | Amount of time the root cause analysis (RCA) data is retained in the HealthBot RCA database. By default, data is retained for 7 days. The data must be entered in hours or days. For example, 1 day is entered as 1d or 24h. |
You can now apply the retention policy to a device group. For information on how to apply a retention policy to a device group, see Adding a Device Group.
To add a network group:
The following table describes the attributes in the Add a Network Group window:
Attributes | Description |
|---|---|
Name | Name of the network group. (Required) |
Description | Description for the network group. |
Reports | In the Reports field, select one or more health report profile names from the drop-down list to generate reports fo the network group. Reports include alarm statistics, device health data, as well as device-specific information (such as hardware and software specifications). To edit or view details about saved health report profiles, go to the System page under the Settings menu in the left-nav bar. The report profiles are listed under Report Settings. For more information, see Alarms and Notifications. |
Notifications |
For more information, see Alarms and Notifications. |
Ingest Frequency | Select existing Ingest Frequency Profiles to override rule or sensor frequency settings. |
Logging Configuration | You can collect different severity levels of logs for the running HealthBot services of a network group. Use these fields to configure which log levels to collect: Global Log Level—From
the drop-down list, select the level of the log messages that you
want to collect for every running HealthBot service for the network
group. The level is set to error by default. Log Level for specific services—Select the log level from the drop-down list for any
specific service that you want to configure differently from the Global Log Level setting. The log level that you select for
a specific service takes precedence over the Global Log Level setting. For more information, see Logs for HealthBot Services. |
Publish | You can configure HealthBot to publish HealthBot sensor and field data for a specific network group: Destinations—Select
the publishing profiles that define the notification type requirements
(such as authentication parameters) for publishing the data. To edit or view details about saved publishing profiles, go to the System page under the Settings menu in the left-nav bar. The publishing profiles are listed under Notification Settings. Field—Select the HealthBot
rule topic and rule name pairs that contain the field data you want
to publish. |
To edit a network group:
See Adding a Network Group for a description of each attribute.