Skip to content

Choosing an integration

An integration describes a situation: guest Wi-Fi, payment terminals, a contractor who needs remote access. It creates everything that situation needs. The catalogue is on the Integrations page, under Building blocks in the device menu, as Available integrations. Integrations covers creating one and managing it afterwards.

The catalogue in the product is the reference for what each integration does, because it always matches the version you are running.

Finding one

  • Search the catalogue… filters by name and description.
  • The category buttons narrow the list: All, Network, Security, Connected equipment, Vendor, Server.
  • The list has two groups:
    • Equipment and suppliers — the flows a named system needs. Start here if you know what you are installing.
    • Network patterns — a kind of network you build yourself: guest Wi-Fi, an isolated VLAN, a published service.

When the gateway recognises several devices from one vendor on a network, the page suggests the integration for them, e.g. {count} {vendor} devices seen on {iface}, with Set it up and Dismiss. Detected equipment shows the same suggestions.

What an integration can create

Depending on the integration: interfaces (a VLAN, a network, a VPN tunnel), DHCP servers, network objects and services, schedules, firewall rules, NAT rules, routes, device settings and published services. Everything it creates stays linked to it, so it can all be removed together.

Integrations that read your network labels

Some integrations ask nothing about wiring. Instead they find the network you have labelled for a role (Guest, Connected equipment (IoT), Telephony (VoIP), DMZ, Servers) and apply themselves to it. The same integration then works on any site, whichever port that network is on.

If the label is missing, the integration says Needs a network labelled: {roles}. Set the label on the network itself, in Local networks.

Read it before you create it

Each integration's form starts with its notes (on an installed one, What this profile does opens them again):

  • what it is for
  • Before you start — what it expects to exist already
  • What this refuses — what it deliberately does not do
  • How to tell it worked — the checks to run afterwards

"What this refuses" is where you learn, for example, that isolating a guest network does not limit its bandwidth: the device has no traffic shaping.