An on-premises plugin connects a service running in your internal network to SquaredUp. They require an agent installed on a machine that has access to your internal network.

1. Create a unique API key for your agent and add the agent to an agent group in SquaredUp.

   You create an API key by creating an agent in SquaredUp:
   

   1. Go to Settings > Relay and add an Agent.

   2. Give the new agent a name and a description that helps you identify where the agent is installed. For example:
      Name: server1.domain.local

      Description: Test server in production domain

   3. Choose the Agent Group for this agent:

      1. If you already have agent groups, assign it to an existing group and click create.

      2. If you don't have any agent groups yet or want to assign the new agent to a new group, leave the Agent Groups field empty and click create. Then create the agent group by clicking on Add Agent Group and select the new agent in the Agents field for the new group.

   4. After you created the agent, the API key for this agent will be shown to you. Copy the key and store it until you inserted the key into the configuration of the agent you want to deploy on your machine.

      The API key will only be displayed to you once. If you lose this API key, you need to generate a new one (by creating a new agent) and any references to the old API key in the configuration of the agent you deployed on your machine will need to be updated.

   5. The Agent status will show as gray until the next stage of configuring the service is completed successfully.

2. Deploy the agent on a machine that has access to the service the plugin connects to.

   1. Download the latest release of the SquaredUp Agent zip file, by clicking the download icon under Options next to the Agent you have just added.

      Prerequisites for Agents

      • The Agent needs to run on a Windows machine that has access to the data source for the on-premises plugin

      • Make sure the Agent is able to make outbound connections on port 443 (no inbound required) to SquaredUp and Microsoft APIs (Azure Relay).

      • Optional DNS-based restrictions: *.servicebus.windows.net

   2. On a Windows machine, with access to the data source your plugin needs to use, extract the downloaded zip file.

   3. In the directory of the extracted zip file, open PowerShell as an administrator and run the following command:

      Copy

      ./Install-SQUPAgent.ps1 -ApiKey "key" -AsService -ServiceSuffix "name" -ServiceAccount domain\username

      Parameters to replace:

      -ApiKey "key"	Mandatory	Replace key with the API key you created for the Agent in SquaredUp
      -AsService	Recommended	Run the Agent as a service on the machine
      -ServiceSuffix "name"	Optional	To change the default service name of squpagent replace name with your new service name.
      -ServiceAccount domain\username	Optional	To run the Agent as a domain service account (for example, for the SCOM plugin), provide the username as domain\username and it will prompt for the password when it sets up the service

   Running the Agent as a domain service account

   By default, the SquaredUp agent service uses the local system identity, but this can be changed to a domain service account if required, for example for the SCOM plugin.

   • Configure a domain service account using the installation script, for example:

     ./Install-SQUPAgent.ps1 -ApiKey "key" -AsService -ServiceAccount domain\username

     where key is the API key, and domain\username is the domain service account

   • Alternatively, in Services > SquaredUp Cloud Agent > Properties select the account on the Log On tab.

   • Use a dedicated user account for the agent's service identity. Create a special service account for this domain service account, do not use an existing user account.

   • The account (typically a service account) needs to have the log on as a service permission.

   4. Adjust any permissions for the service and start the service.

      How to start the Agent service

      You can start the agent service from Services > SquaredUp Cloud Agent, or using PowerShell using either:

      Start-Service -Name <ServiceName>

      Where <ServiceName> should be replaced with the service name shown in brackets in the upgrade script output (or Properties of the service).

      For example:

      Start-Service -Name squpagent

      or

      Start-Service -DisplayName <DisplayName>

      Where <DisplayName> should be replaced with the service name shown before the brackets in the upgrade script output (or Properties of the service).

      How to find the Agent folder location or Service name in Properties

      Look at the Properties of the SquaredUp Cloud Agent service:

      1. On the server running the Agent, open Services

      2. Scroll down to the SquaredUp Cloud Agent in the list

      3. Right-click on the SquaredUp Cloud Agent service and then Properties

      4. Here you can see the Service name, Display name and Path to the Agent folder.

      5. You can also start or stop the service from here.

   5. Check the Agent status in SquaredUp  Settings > Relay