[UniFi] [Network] [IP] Version [1.0]

Introduction & Manufacturer Profile

UniFi Network is Ubiquiti's comprehensive network management platform that delivers enterprise-grade networking solutions for homes and businesses. Built on the foundation of centralized management and scalability, UniFi Network offers a complete ecosystem of switches, access points, and security gateways that work seamlessly together.

The UniFi Network platform provides professional-grade networking capabilities with an intuitive interface, making advanced network management accessible to both IT professionals and technical enthusiasts. With features like VLAN management, PoE control, and real-time monitoring, UniFi Network enables complete control over your network infrastructure.

UniFi Network represents Ubiquiti's commitment to providing professional networking solutions that prioritize performance, reliability, and ease of management while maintaining enterprise-level features suitable for both residential and commercial deployments.

Version History

Version 1.0

Initial Release

System Requirements & Prerequisites

RTI System Requirements

Integration Designer: 11.12 or later.

XP FW: 22.3.31 or later.

Driver Information

Supports Switches, and Access Points.

Requires a Local API Key generated from the UniFi Protect interface.

Direct network communication to the UniFi Gateway device (UDM, UNVR, or Cloud Key).

For remote configuration, use UniFi Teleport VPN connection.

Network Requirements

The RTI processor must have network access to the UniFi Gateway device.

HTTPS communication on port 443.

For off-site programming, establish a Teleport VPN connection first.

Obtaining Your API Key

To use this driver, you must generate a Local API Key from your UniFi Protect system:

Step 1: Access UniFi Network Settings

Open the UniFi Network web interface or mobile app

Navigate to Settings (gear icon)

Select Control Plane from the left menu.

Select the Integrations Tab.

Step 2: Generate the API Key

Under the Your API Keys section enter a descriptive name (e.g., "RTI Control System")

Select Never Expire from the dropdown menu.

Select Create API Key.

The system will display your API key only once - copy it immediately

Store the key securely - you cannot retrieve it later

Important Notes:

If you lose your API key, you must generate a new one

API keys can be manually revoked at any time

For security, create a dedicated user account for the integration rather than using your personal admin account

Step 3: Create dedicated user

Select the Admins & Users menu item below the settings cog

Select Create New, Create New User

Enter the Name, and enable the admin checkbox.

Select Create

Once created, select the user.

In the popup, select the Settings cog

Enable the Restrict to local access only checkbox

Set Network to Full Management

If using the UniFi Protect driver as well, Set Protect to Full Management as well

Driver Configuration

Initial Setup

Add the Driver

Add the "Unifi Network" driver to Global in Integration Designer

Initial Configuration Wizard

API Key: Enter the Local API Key you generated from UniFi Network

Gateway IP Address: Enter the IP address of your UniFi Gateway device

This is the device running the Network application (UDM, Cloud Gateway or Cloud Key)

Example: 192.168.1.1

Device Discovery

After entering the IP address, click OK when prompted to retrieve the configuration

The driver will automatically discover and configure all UniFi Network devices

This process may take 10-60 seconds depending on the number of devices

Adding Sources

Once the driver has pulled the configuration, any found devices will be listed in the Add to Existing Driver section of the Add Workspace item window.

You need to add any of the devices you want to control to the project from there.

Template Page Names

Use these template page names when creating user interfaces:

Network Switch - For UniFi switches

Driver Features

Switches

Commands

Device Control

Power Cycle Switch - Reboot the switch device

Port Management

Port Selection - Select a port for detailed control and monitoring

None (Close Port Popup)

Port 1 through Port [N] (where N is the number of ports on the switch)

PoE Control (PoE-capable Ports)

Selected Port Power Cycle PoE - Power cycle PoE on the currently selected port

Port [N]: Power Cycle PoE - Power cycle PoE on a specific port (individual controls for each PoE port)

Variables

General

Online - Connection status (Boolean: Offline/Online)

Name - Switch name (String)

Mac Address - Device MAC address

Model - Switch model number (String)

Software Version - Current firmware version (String)

Memory Usage - Current memory utilization percentage (String)

Cpu Usage - Current CPU utilization percentage (String)

Up Time - Device uptime

Selected Port Information

Port Name - Name of the selected port (String)

Link Status - Link state (Integer: 0=Link Up, 1=Link Down)

Speed - Port speed (Integer: 0=Auto Negotiated, 1=100Mb, 2=1Gb, 3=2.5Gb, 4=5Gb, 5=10Gb)

Any Port Selected - Indicates if any port is selected (Boolean, visibility control)

PoE Visible - Shows if selected port has PoE capability (Boolean, visibility control)

PoE Enabled - PoE state on selected port (Boolean: PoE Enabled/PoE Disabled)

PoE Active - PoE power delivery state (Boolean: PoE Active/PoE Inactive)

Individual Port Information (Per Port)

Is Selected - Indicates if this port is currently selected (Boolean)

Port Name - Port identifier (String)

Port Mode - Port operational mode (Integer)

Port State - Port enabled/disabled state (Boolean: Enabled/Disabled)

Link Status - Physical link state (Boolean: Link Up/Link Down)

Speed - Negotiated port speed (Integer: 0=Auto Negotiated, 1=Unknown, 2=100Mb, 3=10Mb, 4=Unknown, 5=Unknown, 6=10Gb, 7=1Gb)

PoE Port Variables (PoE-capable Ports Only)

PoE State - PoE port enabled/disabled (Boolean: Port Enabled/Port Disabled)

PoE Active - PoE power delivery active (Boolean: PoE Enabled/PoE Disabled)

Events

Connection Events

Offline - Switch disconnected from network

Online - Switch connected to network

Port Events (Per Port)

Link Up - Physical link established on port

Link Down - Physical link lost on port

PoE Events (PoE-capable Ports Only)

PoE Delivering Power - PoE actively delivering power to connected device

PoE Not Delivering Power - PoE not delivering power (device disconnected or PoE disabled)

Access Points

Commands

Device Control

Power Cycle Access Point - Reboot the access point device

Variables

General

Online - Connection status (Boolean: Offline/Online)

Name – Access Point name (String)

Mac Address - Device MAC address

Model – Access Point model number (String)

Software Version - Current firmware version (String)

Memory Usage - Current memory utilization percentage (String)

Cpu Usage - Current CPU utilization percentage (String)

Up Time - Device uptime

Port Information (Per Port)

Port Name - Port identifier (String)

Port Mode - Port operational mode (Integer)

Port State - Port enabled/disabled state (Boolean: Enabled/Disabled)

Link Status - Physical link state (Boolean: Link Up/Link Down)

Speed - Negotiated port speed (Integer: 0=Auto Negotiated, 1=Unknown, 2=100Mb, 3=10Mb, 4=Unknown, 5=Unknown, 6=10Gb, 7=1Gb)

Events

Connection Events

Offline – Access Point disconnected from network

Online – Access Point connected to network

Port Events (Per Port)

Link Up - Physical link established on port

Link Down - Physical link lost on port

Troubleshooting

Common Issues

Driver won't connect to gateway:

Verify the gateway IP address is correct

Ensure the RTI processor can reach the gateway (ping test)

Confirm the API key is valid and hasn't been revoked

Check that the gateway is running the latest Network firmware

Devices not appearing after configuration:

Refresh the driver configuration

Use "Retrieve Devices" from the driver menu

Verify devices are adopted and online in UniFi Network

Make sure you have added any devices you want to control to the project from the Add to Existing Driver section of the Add Workspace Item window.

Variables showing incorrect values:

Allow time for initial polling cycle to complete (up to 30 seconds)

Verify the device firmware is up to date in UniFi Network

System Testing

Integration Designer 11.12:

XP Processor Model: XP-6s

XP Processor Firmware: 25.9.24

Device Model(s): Multiple Switches and Access Points

Support Contact

RTI Control

+ 1.952.253.3137

support@rticontrol.com