Documentation

Connectors

This page is also in the Groundskeeper wiki: https://github.com/rsjsoftwareltd/groundskeeper/wiki/Connectors

Connectors are how Groundskeeper reads from the systems your school already runs. Each one pulls status into the dashboard, the feed, and the SLT view.

Every connector is read-only. Groundskeeper never writes to, changes, or controls anything on a monitored system -- it only reads status. Credentials are stored encrypted at rest on your server (Windows DPAPI) and never leave your network except as the direct API call to the service being monitored.

Connectors are enabled and configured on the Connector Settings page (in the left-hand menu). Each connector card has a Test connection button so you can confirm the credentials work before relying on it, and inline help on every field. On the free Community edition you can enable up to 5 connectors; Pro lifts the limit.

Most connectors take a poll interval (how often to check). The defaults below are sensible starting points -- shorter for fast-moving things (device status), longer for slow ones (warranty, certificates, licence counts).

A note on the Windows-infrastructure connectors (Windows Servers/Clients, Hyper-V, DNS & DHCP, Active Directory, Endpoint Reports, AD-based discovery): these reach the servers over WMI (DCOM -- WinRM is not needed) and query AD, so Groundskeeper should run on a domain-joined Windows Server, and the relevant RSAT feature must be installed (noted per connector).


Infrastructure & hardware #

Cisco Meraki #

Aruba Central (Beta) #

Veeam #

If Veeam says "License restrictions apply". Veeam opens its REST API only on Enterprise Plus, or a Universal Licence, for socket licences, so on other editions the poll fails with "refused the REST API because of its licence". Change that server's How to read Veeam to Veeam PowerShell (any edition; needs remote PowerShell to the backup server), save, and press Test connection. Groundskeeper then reads the jobs through Veeam's own read-only PowerShell cmdlets on the backup server, which work on every edition. The backup server needs:

Hyper-V #

DNS & DHCP #

Switches (SNMP) #

UPS #

Dell iDRAC #

WatchGuard Firebox #

WatchGuard's REST API doesn't expose live reachability or VPN tunnel status (the Management API is configuration-only; the Reports API is historical traffic analytics), so this connector polls the Firebox directly over SNMPv3 instead. Alarm traps aren't implemented yet -- that would need a separate always-on trap listener and is tracked as a possible future connector.

FortiGate (Beta) #

Synology NAS (Beta) #

HPE iLO (Beta) #

Ping checks #


Cloud & online services #

Setting up the Microsoft 365 app registration (once, for all three) #

The Microsoft 365 connectors (Service Health, Licence Usage, Public SharePoint sites) share one app registration in your tenant. It only reads, and you choose which permissions it has. You need a Global Administrator (or Privileged Role Administrator) for step 4.

  1. In the Microsoft Entra admin centre (or Azure portal), go to Applications > App registrations > New registration. Name it Groundskeeper, choose Accounts in this organizational directory only, leave the redirect URI empty, and click Register.
  2. On the app's Overview, copy the Application (client) ID and the Directory (tenant) ID.
  3. Open API permissions > Add a permission > Microsoft Graph > Application permissions and tick only the ones for the connectors you will use: ServiceHealth.Read.All (Service Health), Organization.Read.All (Licence Usage), Group.Read.All (Public SharePoint sites). Click Add permissions. (Application permissions, not Delegated.)
  4. Click Grant admin consent for your organisation. Each permission's status should turn to a green tick. Until it does, Test connection for Service Health and Licence Usage says the permission is missing. The Public SharePoint sites test checks the sign-in only, so a missing Group.Read.All shows on that connector's first poll instead.
  5. Open Certificates & secrets > Client secrets > New client secret, give it a description and an expiry (at most 24 months), and copy its Value straight away -- it is shown only once. The Secret ID beside it is not the secret.
  6. In Groundskeeper's Connector Settings, paste the tenant ID, client ID and secret value into each Microsoft 365 connector and click Test connection.

Put the secret's expiry date in your calendar: when it expires the connectors report "the client secret has expired" until you add a new one (step 5) and paste its value in.

Microsoft 365 -- Service Health #

Microsoft 365 -- Licence Usage #

Public SharePoint sites (Beta) #

Adobe -- Licence Usage #

School Services #

Internet Health #


Security & compliance #

Domain Security #

SSL Certificates #

WatchGuard Endpoint #

Windows Event Log #

Active Directory #


Endpoints (agentless) #

These connectors read endpoint data over the network from a domain-joined Groundskeeper server, without the optional RSJ Agent. (For richer per-device detail -- BitLocker, Defender, SMART, battery health and more -- deploy the RSJ Agent to your endpoints; see Getting Started.)

Windows Servers #

Windows Clients #

Endpoint Reports #

Printers / MFDs #


AD hygiene & school-specific #

AD Account Health #

Devices Left On Overnight #

Exam Marking Software #

MIS Status #


Patch management #

Action1 #


Adding more later #

You can enable, disable or reconfigure connectors at any time on the Connector Settings page -- nothing here is locked in at setup. New connectors are added in Groundskeeper releases; see the Releases page and Discussions to request one.

Last updated: 2026-11-05 (v0.195.0)