BVQ icon

BVQ

Get data from the BVQ API

Overview

This node retrieves data from the BVQ API, specifically fetching the latest alerts or events based on user-selected parameters. It is useful for monitoring and analyzing system alerts and events from different BVQ data sources such as Hypervisor/vSphere or Storage/SVC. For example, users can fetch recent error alerts from a storage system or retrieve the latest alarm events from a hypervisor environment.

Use Case Examples

  1. Fetch the latest 'Error' type alerts from BVQ/Storage/SVC within the last 2 hours.
  2. Retrieve the latest 'Alarm' type events from BVQ/Hypervisor/vSphere for the past 30 minutes.

Properties

Name Meaning
Data Type Selects whether to retrieve 'Alerts' or 'Events' from the BVQ API.
Event Source Specifies the source to retrieve events from, applicable only when 'Data Type' is 'Events'.
Alert Source Specifies the source to retrieve alerts from, applicable only when 'Data Type' is 'Alerts'.
Event Type (Hypervisor) Type of event to retrieve from BVQ/Hypervisor/vSphere when 'Data Type' is 'Events' and source is Hypervisor/vSphere.
Event Type (Storage) Type of event to retrieve from BVQ/Storage/SVC when 'Data Type' is 'Events' and source is Storage/SVC.
Alert Type Type of alert to retrieve when 'Data Type' is 'Alerts' and source is either Hypervisor/vSphere or Storage/SVC.
Time Value (Events) Numeric value specifying the time period for retrieving events, used with 'Time Unit (Events)'.
Time Unit (Events) Time unit for the events time period (e.g., minutes, hours, days).
Time Value (Alerts) Numeric value specifying the time period for retrieving alerts, used with 'Time Unit (Alerts)'.
Time Unit (Alerts) Time unit for the alerts time period (e.g., minutes, hours, days).

Output

JSON

  • json - The JSON response from the BVQ API containing the requested alerts or events data.

Dependencies

  • Requires BVQ API credentials including username, password, API key, and API base URL.

Troubleshooting

  • Missing or invalid BVQ API credentials will cause the node to throw an error 'Missing credentials for BVQ API.' Ensure credentials are correctly configured.
  • If the BVQ API request fails, the node throws an error 'BVQ API Request Failed' with the underlying message. Check network connectivity, API endpoint correctness, and credential validity.
  • Incorrect parameter combinations (e.g., selecting event-specific parameters when 'Data Type' is 'Alerts') may lead to unexpected results or empty responses. Verify parameter selections.

Discussion