Liongard

Roar Users Guide & Documentation

Welcome! You'll find comprehensive guides and documentation to help MSPs start working with Liongard's Roar as quickly as possible, as well as support if you get stuck. Let's go #MakeITRoar!

Get Started    

Microsoft Power BI

The Liongard and Power BI integration is based on access to Liongard's API. There are multiple ways to access Liongard's data in Power BI, the most streamlined being Liongard's Power BI Data Connector.

For more information on accessing Liongard's API, please refer to our Developer Guide.

To get started and take advantage of Liongard's Power BI Data Connector, complete the following steps in Liongard and Power BI.

Please note Liongard's Power BI Data Connector currently only supports GET requests from Liongard's API.

Liongard's Power BI Data Connector

Step 1: Open Power BI Desktop

📘

Configuring Power BI Desktop

It is necessary to configure Power BI Desktop to allow unsigned customer connectors.

Liongard is in the process of getting our Power BI data connector signed and certified by Microsoft.

  1. Open Power BI Desktop.
  2. Enable the Custom Data Connectors feature in Power BI Desktop:
  • Navigate to File > Options and settings > Options > Security > Under Data Extensions > Select "Allow any extension to load without validation or warning."
    • Note: Depending on your version of Power BI, this feature may also be enabled by navigating to File > Options and settings > Enable the checkbox for "Custom data connectors."
  1. Press OK and restart Power BI Desktop

Step 2: Obtain and Encode your API Key and Secret

🚧

Access Key/Secret

The Power BI Data Connector will require you to have a Liongard Access Key and Secret upon setup. If you have documented your Key and Secret from previous Agent installs, then you may use the same credentials in the Power BI Data Connector.

Otherwise, you may create an Access Key and Secret by navigating, in your Liongard instance to Your Name > Account Settings > Access Tokens > Generate a New Token.

Windows Systems

  1. Download and open the Base64 Encoding PowerShell script.
  1. In the script, remove the comments from Line 1 and Line 2, and put in your Access Key and Access Secret respectively.

  2. Run the Script. This will provide you with a Base64 encoded key. Be sure to save this key using security best practices.

Alternatively, you can just copy and paste this code into PowerShell, ensuring you add your Access Key and Access Secret respectively.

$key = #your key here in quotes
$Sec = #your secret here in quotes 
$Text = $key + ":" + $Sec
$Bytes = [System.Text.Encoding]::UTF8.GetBytes($Text)
$EncodedText =[Convert]::ToBase64String($Bytes)
$EncodedText

Mac or Linux-based Systems

  1. Once you have your Liongard Access Key and Secret, open a terminal window and Base64 encode them as a single-string with a colon between them using this command:

echo -n 'accessKeyId:accessKeySecret' | base64

You may prefer to use a website, such as https://www.base64encode.org, to do the encoding.

  1. Copy and paste the result to a temporary location. You'll need this later when configuring the Power BI Data Connector.

Step 3: Install the Liongard Power BI Data Connector

  1. Download the Liongard Power BI Data Connector to your local machine and place it in C:\Users\yourname\Documents\Power BI Desktop\Custom Connectors

Step 4: Get Data

The Liongard Power BI Data Connector currently only supports GET requests from Liongard's API. Prior to setting up the integration, review our Developer Guide to determine what data you would like to access in Power BI.

If you would like to access Liongard's Metrics in Power BI, Metrics will need to be enabled in Liongard. Follow the steps below to Enable Metrics in Liongard.

System IDs and Metric IDs

The Power BI Data Connector calls the Liongard API. When querying Metrics in bulk, it needs to know the IDs of the Systems and Metrics you would like to retrieve.

We recommend starting the integration with Systems and Metric endpoints to obtain the System and Metric IDs that will be needed later to retrieve your Metrics.

To obtain the System and Metric IDs, first, point the Data Connector at the Systems and Metrics endpoints. You can do that from the command line with curl as described in our API documentation or directly in Power BI.

Here's an example of how to use curl to retrieve all of your Active Directory System IDs.

# NOTE: You need to replace "myinstance" with the URL name you use to access Liongard
ENCODEDAUTH="`echo -n 'accessKeyId:accessKeySecret' | base64`"
curl -L -G --header "X-ROAR-API-KEY: $ENCODEDAUTH" https://myinstance.app.liongard.com/api/v1/systems/ --data-urlencode 'conditions[]={"path":"Inspector/Name","op":"equals","value":"active-directory-inspector"}' --data-urlencode 'orderBy[]={"path":"CreatedOn","order":"desc"}'

Once you've determined the data you would like to access, follow the steps below

  1. In Power BI Desktop, click Get Data in the Home ribbon.
  2. Search for Liongard in the list of data connectors. It will be listed under "Online Services."
  3. Select Liongard and click Connect.
  4. The data connector will ask you for a URL to connect. Provide any valid Liongard API URL to bring back a table of Liongard data. API URLs can be found in our Developer Guide

Enabling Metrics in Liongard

If you would like to access Metrics in Power BI, you will need to enable them in Liongard. Follow the steps below to enable Metrics:

  1. In Liongard, navigate to Admin > Metrics.
  2. Select the Metrics you'd like to access in Power BI and enable the "Display" toggle.

Video not playing? Watch the video here.

Publishing to the Power BI Cloud and Configuring Automatic Refresh

After you have created a resource (report, dashboard, etc.) in Power BI Desktop, you may wish to share it with your colleagues. One way to do that is to publish it to your organization's Power BI Cloud service and install and configure the Microsoft Power BI Gateway to do scheduled refreshes of your report's dataset. To do so, follow the steps below:

  1. Download, install, and configure the Microsoft Power BI Gateway from https://powerbi.microsoft.com/en-us/gateway/. Be sure to enable the Liongard Data Connector in the Gateway in the Connectors tab.

  2. In Power BI Desktop, make sure that you are signed in to your Microsoft 365 account, open your file, and click Publish in the toolbar.

You will be asked to select a cloud workspace from your account as the destination for your report. We recommend, using "My Workspace" as a default.

  1. Log in to app.powerbi.com and navigate to Workspaces > My Workspace. You will see your newly published report as well as its Dataset(s).

  2. To schedule an automatic refresh of the Dataset(s), click the Dataset settings:

  • First, check the Gateway connection and ensure that it is toggled on and that the correct Gateway is applied and running.
  • Then, click Data source credentials > Provide your Base64 encoded Liongard API Key > click the Scheduled refresh link.

Let us know your feedback!

Jump into our Slack community, the Liongard Lounge, to let us know how you're using this integration and/or provide your Ideas for this integration in Liongard's Ideas Portal.

Updated 2 months ago


Microsoft Power BI


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.