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

👍

Datto ComStore

A script for Liongard's On-Premise Agent is now available in Datto's ComStore.

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.
  1. 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.
  1. 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
  1. Agent Names must be unique. Include a unique identifier in the Agent script to ensure all Agents will have a unique name.

👍

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 will be supported on a best-effort basis.

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: Download the Script from the Datto ComStore

Part 1: Create New job and Set Variables

  1. Log in to your Datto RMM instance

  2. In Datto RMM, navigate to ComStore > Scripts

  1. Use the Top Navigation to search for the Liongard Script. This will lead you to the screen below:
  1. Here you'll be able to Download the script into your components library:
  1. You will now find the script in your components library.

Part 2: Create new job and Set Variables

Once the Script has been downloaded, you will be able to schedule new jobs and populate required variables

📘

Obtain a Roar Access Key and Secret

For a successful installation, you will need to obtain a Roar Access Key and Secret.

To do so, in Roar, navigate 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.

  1. Select the Liongard script component and select the gear at the top to schedule a new job
  1. Upon Job setup, you will see the Liongard script variables that need to be populated for successful Agent install

🚧

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.

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 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 installation.
  • roarURL: Enter your Roar URL (e.g. us1.app.liongard.com)
  • 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 installation.
  • 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 and Run the Script

  1. You can finish the configuration of the Job by selecting a target for the script to run against. You can also set a schedule for the script.
  1. Optionally, you can configure additional alerting and options for the script.
  1. Once you save these changes, the script will proceed to run

📘

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.

❗️

adServer = "true"

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

❗️

Setting Variables

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

Step 2: Roll out Auto-Discovered Inspectors

👍

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 wil continue.

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.

Last Updated: 2020-07-30

Updated 11 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.