Liongard Roar

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    

Deployment via Datto RMM

On-Premise Agent Overview

On-Premise Agent Installation Best Practices

  1. Install On-Premise Agents on Domain Controllers
    • We support On-Premise Agents being installed on servers; however, installing an On-Premise Agent on a Domain Controller will result in more Inspector Auto-Discovery, and therefore, less manual work.
  2. Generally, Install One On-Premise Agent per Network
    • Our Agents speak across VPN tunnels
    • Our Agents DO NOT speak across Active Directory Domains, so if you have two Active Directory Domains in one network, then you'll need an Agent within each Active Directory Domain.
  3. Install an Additional On-Premise Agent on any Server NOT Tied to an Active Directory Domain
    • The additional Agent will auto-activate an Inspector for the local Windows server, and that Inspector will auto-discover a Hyper-V or SQL Server Inspector if either system is present

On-Premise Agent Installation = Inspector Auto-Discovery

When you roll out an On-Premise Agent, there is a potential for the Auto-Discovery of four Inspectors:

  1. Upon install, an On-Premise Agent will auto-activate an Inspector for the local Windows Server
  2. After the Windows Inspector runs, it will auto-discover an Active Directory Inspector
  3. Once activated and successfully run, the Active Directory Inspector will auto-discover Inspectors for any additional Windows servers within its Domain
  4. Once activated and successfully run, the Windows Inspectors will Auto-Discover Inspectors for any Hyper-V or SQL Server Inspectors installed

Script Overview

The script below provides for a basic install of the Roar Windows Agent via Datto RMM using our MSI Installer. It takes in variables associated with your Roar instance, such as the URL and Access Key ID and Secret, to complete the install.

This script can:

  • Install an On-Premise Agent
  • (Optionally) Create a Domain Admin User
    • Assign the Domain Admin User to the Agent

This script cannot:

  • Assign the Agent to an Environment

Step 1: Import the Script

Part 1: Import the Script

  1. Click on the Datto RMM Script Link and save it as a file.

  2. In Datto RMM, navigate to Components > Scripts > Select "Import Component" on the left sidebar

  1. This will trigger a pop up. Here, select Choose File > Choose your file > Select Upload

This will lead you to the screen below:

  1. Here you'll find the PowerShell Script and two fields to edit:
    • Name: (Suggested) Roar Windows Agent Installer
    • Select the "This component requires site credentials" checkbox
      • Note: If intending to run this script on a Domain Controller(s), and therefore, the "adServer" variable is set to "True," then this checkbox must be selected.

"This component requires site credentials" Checkbox

If you plan to run this script on a Domain Controller and plan to use the Domain Admin user creating capability of this script, then this checkbox must be selected.

If you run this script on a Domain Controller and plan to pass in the credentials of an already existing Domain Admin Active Directory user, then this checkbox does not need to be selected.

Part 2: Set Default Values & Customize the Script

Here, you will need to set default values for each of the variables listed. These default values can be further edited upon running the script.

Creating a Domain Admin User

This script, optionally, creates a Domain Admin User in Active Directory.

If you would not like this script to create a Domain Admin User, you can:

  1. Leave the "adServer" set to "true," and enter the credentials of an existing Active Directory user in the variable fields "roarSvcUsername" and "roarSvcPassword"
  2. Set the "adServer" set to "false"

Creating a Domain Admin User for the Agent to "Run As"

If the "adServer" variable is set to "true," then this script will check if the Username and Password entered into the Default Values fields matches the Username and Password for an existing user.

  • If the values match those of an existing user, then it will assign the Agent to "Run As" that user.
  • If the values do not match those of an existing user, then it will create a user with the Username and Password set in the Default Values fields, add the user to the Domain Admins group, and assign the Agent to "Run As" that user.

If the "adServer" variable is set to "false," then this script will ignore the Username and Password entered into the Default Values fields.

Obtaining a Roar Access Key and Secret

This can be created in Roar by navigating to your User Account Name in the top right corner > Account Settings > Access Tokens > Generate a New Token

These keys can be used for every Agent installation, or you can create a new one each time you install an Agent.

Fill in the following fields:

  • roarAccessKey: Enter a Roar Access Key
  • roarAccessSecret: Enter a Roar Access Secret
  • roarSvcPassword: Enter a Roar Service Account Password that you would like to auto-created by the script for the Agent.
    • Note: This user will not be created, and this default value will be ignored if, before running the script, this value is edited to, or already reflects, the values of an existing Active Directory User. This can be edited upon install.
  • roarURL: Enter the first subdomain of your Roar URL (e.g., "us1")
  • roarSvcUsername: Enter a Roar Service Account Username that you would like auto-created by the script.
    • Note: This user will not be created, and this default value will be ignored if, before running the script, this value is edited to, or already reflects, the values of an existing Active Directory User. This can be edited upon install.
  • adServer: The Default Value is by default set to "true" meaning that this script will fail if run on a non-Domain Controller server. Change this to "false" if you would like to install an On-Premise Agent on non-Domain Controller servers
    • Note: If set to "false," the script will not create an Active Directory User or assign the Agent to "Run As" an Active Directory User

Part 3: Finish Configuring

  1. Select Save
  1. If you would like to run this script as a Quick Job, select the star icon

Step 2: Run the Script

  1. Navigate to Sites > Select the Site that you would like to deploy an Agent for > Select their Devices tab
  1. Select the server, preferably a Domain Controller, you would like to install an Agent on

adServer = "true"

If the "adServer" variable is set to "true," then this script will fail if run on non-Domain Controller servers.

  1. This will direct you to their Summary tab. Select the Actions drop down menu.

Here you can either Schedule a Job or Run a Quick Job.

Schedule a Job

Select Schedule a job > Enter a Name for the job > Set the Schedule to "Immediately" or "Click to change" > Select Add a Component > Select the name of your Roar Agent install script > Select Save

Under Components, Confirm your variables.

Setting Variables

Each variable must be filled in upon install, or the script will fail.

Optionally, select to "Alert me if."

Select Save

  • Note: Once saved, this job will immediately run

Run a Quick Job

Select Run a Quick Job > Select the name of your Roar Agent install script > Confirm your variables

Setting Variables

Each variable must be filled in upon install, or the script will fail.

Select Save.

  • Note: Once saved, this job will immediately run

Step 3: Roll out Auto-Discovered Inspectors

Associating the Agent to an Environment in Roar

This script does not associate Agents with their Environments. This will need to be completed in Roar.

You can do this in Roar by navigating to Admin > Agents > Select the Agent installed > Fill the Environment field with the associated Environment. This field is case sensitive.

On-Premise Agent Auto-Discovery

Remember there is a lot of Auto-Discovery that follows installing just one On-Premise Agent in Roar!

In Roar, after installing an On-Premise Agent (including associating it to an Environment), a Windows Inspector for the local Windows Server where the Agent was installed will be Auto-Activated.

After this Inspector runs, if the Agent was installed on a Domain Controller, then this Auto-Activated Windows Inspector will Auto-Discover an Active Directory Inspector, and the Auto-Discovery continues.

You can activate Auto-Discovered Inspectors on your Dashboard Screen by navigating to the. "Discovered Systems" tab. For more information on Auto-Discovery, please review our documentation.

Agent Fail Logs

If this script fails, you can find an install log in the temporary folder c:\Windows\Temp, called install.log.

Using Automation with Roar

Thanks to Stuart Brannon for sharing the script above. If you'd like to share how your team is using automation with Roar, email us at [email protected]

Last Updated: 2020-01-22

Updated 27 days ago

Deployment via Datto RMM


Suggested Edits are limited on API Reference Pages

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