Unifi Syntax

4 min read Oct 11, 2024

Unifi Syntax: A Comprehensive Guide

Unifi, a powerful network management platform, offers a flexible and robust command-line interface (CLI) for managing your network devices. The CLI utilizes a syntax that allows for precise and efficient configuration changes. This guide will dive into the intricacies of Unifi syntax, empowering you to navigate and manage your network with ease.

What is Unifi Syntax?

Unifi syntax is the specific language structure used for interacting with the Unifi Controller via the CLI. It's based on a combination of commands, keywords, and arguments. Understanding this syntax is crucial for:

Configuring devices: Setting up access points, switches, gateways, and more.
Troubleshooting problems: Identifying and resolving network issues.
Automating tasks: Creating scripts for repetitive or complex tasks.

Understanding the Basics

Commands

Commands are the primary actions you perform within the Unifi CLI. Common commands include:

configure: Modify device settings.
show: Display information about devices, networks, and other elements.
set: Change specific device properties.
delete: Remove devices, networks, or other configurations.

Keywords

Keywords are essential elements that specify the target of a command. Common keywords include:

device: Targets a specific device.
network: Targets a specific network.
name: Specifies a name for a device or network.
ip: Targets a device based on its IP address.

Arguments

Arguments provide additional information to commands and keywords. They specify details like:

ssid: Name of the Wi-Fi network.
password: Password for a network or device.
vlan: VLAN ID for a network.
port: Port number for a service.

Examples

1. Setting a Device Name:

configure device name 'MyAP' device '192.168.1.10'

This command changes the name of the device with the IP address 192.168.1.10 to 'MyAP'.

2. Creating a New Network:

configure network name 'GuestNetwork' type 'guest'

This command creates a new guest network named 'GuestNetwork'.

3. Showing Device Information:

show device ip '192.168.1.10'

This command displays information about the device with the IP address 192.168.1.10.

Tips and Tricks

Use the help command: The help command provides detailed information about specific commands and keywords. For example, help configure will display information about the configure command.
Experiment with the CLI: The best way to learn Unifi syntax is by experimenting. Don't be afraid to try different commands and see how they work.
Utilize the Unifi documentation: The official Unifi documentation contains a comprehensive guide to the CLI syntax and commands.

Conclusion

Mastering Unifi syntax is essential for effectively managing your Unifi network. By understanding the commands, keywords, and arguments, you can configure, troubleshoot, and automate your network with ease. Remember to leverage the available resources, experiment with the CLI, and consult the Unifi documentation for a seamless and efficient network management experience.