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 Kaseya VSA

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 Kaseya VSA 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

This script can not:

  • Assign the Agent to an Environment
  • Assign an Active Directory User to the Agent for the Agent to "Run As"

RMM Script Limitations

The current version of this script does not set the Agent service's "Run As" user or associate the Agent with an Environment upon install. The script can be modified to meet your particular needs by modifying the parameters passed into our MSI install. Full details of how the MSI is parameterized are available on our MSI Installer Documentation page.

Scripted Install

Step 1: Customize Script

In Step 2 you'll find a XML script. There are a few ways in which to customize this script:

Including the Creation of a User for Roar to "Run As"

Creating a Domain Admin User

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

If you would not like this script to do so, you can:

  1. Delete the "Create Domain User (run on Domain Controller)" Statement

If you would like this script to include creating a Domain Admin user for Roar to "Run As," then you will need to edit the Statement "Create Domain User (run on Domain Controller)"

  • Edit the "value" of the first "StringParameter" to be the desired username for the Active Directory User
  • Edit the "value" of the second "StringParameter" to be the desired password for the Active Directory User
  • (Optional) Edit the "value" of the "EnumParameter" to be the desired group for the Active Directory User

Example:

<Statement name="Create Domain User (run on Domain Controller)" continueOnFail="false">
       <Parameter xsi:type="StringParameter" name="Parameter1" value="liongard\roar" />
       <Parameter xsi:type="StringParameter" name="Parameter2" value="Desired Password" />
       <Parameter xsi:type="EnumParameter" name="Parameter3" value="Domain Admins" />
</Statement>

If you would not like this script to include creating a Domain Admin user for Roar to "Run As," then delete the "Create Domain User (run on Domain Controller)" Statement

Including Roar Variables (Removing the Prompt)

If you would like this script to include your Roar Instance's Variables (URL and Access Key ID and Secret) in order to avoid being prompted to insert the variables at each run, you will need to edit the first three "GetVariable" Statements:

  • Edit each statement where "value=prompt" to "value=ConstantValue"
  • Edit the first statement where "value="Roar Access Key"" to "value=Your Roar Access Key"
  • Edit the first statement where "value="Roar Secret"" to "value=Your Roar Secret"
  • Edit the first statement where "value="Roar URL"" to "value=Your Roar URL"

Example:

 <Statement name="GetVariable" continueOnFail="false">
       <Parameter xsi:type="EnumParameter" name="VariableType" value="ConstantValue" />
       <Parameter xsi:type="StringParameter" name="SourceContent" value="Your Roar Access Key" />
       <Parameter xsi:type="StringParameter" name="VariableName" value="rkey" />
     </Statement>
     <Statement name="GetVariable" continueOnFail="false">
       <Parameter xsi:type="EnumParameter" name="VariableType" value="ConstantValue" />
       <Parameter xsi:type="StringParameter" name="SourceContent" value="Your Roar Secret" />
       <Parameter xsi:type="StringParameter" name="VariableName" value="rsecret" />
     </Statement>
     <Statement name="GetVariable" continueOnFail="false">
       <Parameter xsi:type="EnumParameter" name="VariableType" value="ConstantValue" />
       <Parameter xsi:type="StringParameter" name="SourceContent" value="Your Roar URL" />
       <Parameter xsi:type="StringParameter" name="VariableName" value="roarurl" />
     </Statement>

If not, then you will not need to edit this part of the script.

Step 2: Import Script into Kaseya VSA

  • In Kaseya, in the left side menu, navigate to Agent Procedures > Manage Procedures > Schedule/Create > Private
    • Right click on myProcedures > Import Folder/Procedure
    • Copy xml file below as prompted in Kaseya
<?xml version="1.0" encoding="utf-8"?>
<ScriptExport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.kaseya.com/vsa/2008/12/Scripting">
 <Procedure name="roar deploy export">
   <Body description="Set line 6 with user and credential you want to create.&#xA;Update Line 7 with credentials&#xA;Set line 1 through 3 to static variables to avoid prompt&#xA;Remove line 6 if account is preconfigured">
   
     <Statement name="GetVariable" continueOnFail="false">
       <Parameter xsi:type="EnumParameter" name="VariableType" value="Prompt" />
       <Parameter xsi:type="StringParameter" name="SourceContent" value="Roar Access Key" />
       <Parameter xsi:type="StringParameter" name="VariableName" value="rkey" />
     </Statement>
     <Statement name="GetVariable" continueOnFail="false">
       <Parameter xsi:type="EnumParameter" name="VariableType" value="Prompt" />
       <Parameter xsi:type="StringParameter" name="SourceContent" value="Roar Secret" />
       <Parameter xsi:type="StringParameter" name="VariableName" value="rsecret" />
     </Statement>
     <Statement name="GetVariable" continueOnFail="false">
       <Parameter xsi:type="EnumParameter" name="VariableType" value="Prompt" />
       <Parameter xsi:type="StringParameter" name="SourceContent" value="Roar URL" />
       <Parameter xsi:type="StringParameter" name="VariableName" value="roarurl" />
     </Statement>
     <Statement name="GetVariable" continueOnFail="false">
       <Parameter xsi:type="EnumParameter" name="VariableType" value="MachineGroupID" />
       <Parameter xsi:type="StringParameter" name="SourceContent" value="" />
       <Parameter xsi:type="StringParameter" name="VariableName" value="ID" />
     </Statement>
     <Statement name="GetURL" continueOnFail="false">
       <Parameter xsi:type="StringParameter" name="URL" value="https://d2qy4ywchsni6t.cloudfront.net/RoarAgent.msi" />
       <Parameter xsi:type="StringParameter" name="ResponseFileName" value="#vAgentConfiguration.agentTempDir#\RoarAgent.msi" />
       <Parameter xsi:type="BooleanParameter" name="WaitComplete" value="True" />
     </Statement>
     <Statement name="Create Domain User (run on Domain Controller)" continueOnFail="false">
       <Parameter xsi:type="StringParameter" name="Parameter1" value="" />
       <Parameter xsi:type="StringParameter" name="Parameter2" value="" />
       <Parameter xsi:type="EnumParameter" name="Parameter3" value="Domain Admins" />
     </Statement>
     <Statement name="ExecuteShellCommand" continueOnFail="false">
       <Parameter xsi:type="StringParameter" name="Command" value="msiexec /i #vAgentConfiguration.agentTempDir#\RoarAgent.msi ROARURL=#roarurl# ROARACCESSKEY=#rkey# ROARACCESSSECRET=#rsecret# ROARAGENTNAME=&quot;#ID#&quot; ROARAGENTSERVICEACCOUNT=&quot;#vAgentConfiguration.workgroupDomainName#\&quot; ROARAGENTSERVICEPASSWORD=&quot;&quot; /qn" />
       <Parameter xsi:type="EnumParameter" name="ExecuteAccount" value="System" />
       <Parameter xsi:type="BooleanParameter" name="Is64Bit" value="True" />
     </Statement>
   </Body>
 </Procedure>
</ScriptExport>

Step 3: Choose Machine Groups and Run the Script

  • Agent Procedures > Manage Procedures > Schedule/Create
    • Private > right click on myProcedures > roar deploy export
  • In the Schedule tab, select the checkbox(es) to the left of the machine(s) you want to deploy Roar Agents to (preferably a domain controller)
  • Select Run Now

Depending on how you've customized this script, you may be prompted to populate the following variables:

  • Roar Access Key
  • Roar Secret
  • Roar URL: Insert your Roar URL (e.g., mymsp.app.liongard.com)

Step 4: Assign the Agent to an Environment

  • This script does not assign the Roar Environment to the newly installed Agents, so newly installed Agents will need to be assigned an Environment from the Admin > Agents screen in Roar.
  • If your Kaseya VSA instance has access to company names that precisely match the Roar Environment names, this script can be expanded to add that information as a part of the scripted process by adding the ROARENVIRONMENT= parameter to the msiexec.exe call.
  • Additional details of how our MSI installer is parameterized are available in the MSI Installer documentation.

Using Automation with Roar

Thanks to Roar partner Matt Sanchez for sharing the above Kaseya VSA script. 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 Kaseya VSA


Suggested Edits are limited on API Reference Pages

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