如何透過 Omada 控制器設定站點範本功能

Contents

Objective

Requirements

Introduction

Configuration

How to set up Site Template and Device Template

How to bind the sites to Site Template

How to bind the devices to Device Template

How to unbind the sites to Site Template

How to unbind the devices to Device Template

Verification

Conclusion

FAQ

Related Articles

 

Objective

This article describes how to configure Site Template feature on Omada Controller to facilitate users in batch configuration and management of sites and Omada devices.

Requirements

• Omada Controller (Software Controller / Hardware Controller / CBC, v5.15.20 or above)
• Omada Gateway/Switch

Introduction

站點範本功能是在控制器的全域介面內進行設定，目的是協助使用者批量設定與管理多個站點。大多數站點功能都支援透過站點範本進行設定，例如：網際網路、LAN、WLAN、ACL、URL 過濾、入口網站（Portal）、MAC 驗證等。透過將每個站點綁定至不同的範本，可實現大量站點的批量設定。

例如，當控制器需要管理多個不同的站點，並因業務需求或其他原因需要對這些站點進行批量變更時，您可以事先建立站點範本，然後直接將目標範本套用至指定站點，而無需逐一進入每個站點進行修改。站點數量越多，此功能的效益越顯著。

此外，您也可以在站點範本中建立設備範本，並在將設備綁定至站點範本後，選擇將相同型號的設備綁定至對應的設備範本。例如，在同一站點有大量 SG3452XP v2.20 設備，但其設定內容略有不同，此時可針對不同設定建立多個設備範本（如設定不同的埠、VLAN 介面、靜態路由或服務設定），再將對應的設備範本套用至所需設備上。

本文將根據 Omada 軟體控制器 v5.15.20.0，說明如何設定站點範本功能。

注意:

• 此功能能支援 Omada 控制器 v5.15.20 及以上版本

Configuration

How to set up Site Template and Device Template

Step 1. Log in Omada Controller, go to Global View’s Site Template to click “+ Add New Site Template” in the top right corner of this page, name it and select the optional configuration according to your own needs, then tap the “Create” button and “Edit” button popped out automatically to continue the process. In this article, we name the created ones as mytest, which will be used in the following to refer to this template we created here.

Note:

• Most of the site’s Configurable Modules are supported to be set up in the Site Template, some of them are mandatory and some are optional (you can set them up only if they are selected here). Please refer to FAQ 1 at the end of this article to know all modules supported in Site Template feature in detail.
• After the Site Template is created, its configurable modules cannot be changed.

 

 

 

Step 2. Enter the mytest template, you can find that all mandatory and optional modules selected in the last step are configurable here, then just please set them up according to your own reality. The configuration steps in Settings/Logs/Audit Logs are the same as those in a regular site, so we won't go into detail here, and you can refer to other articles on TP-Link's website to learn more about each function.

 

Step 3 (Optional). Go to Device Template to click “+ Add New Device Template”, edit its name, then select the device type/device model/the configuration modules you would like to set up. Here we take ER7206 v1.0 and SG2008P v3.20 as examples to create 2 templates for them (ER_01 for ER7206 v1.0, SG_01 for 2008P v3.20).

Note:

• Only Omada Gateways and Switches are supported with the Device Template.
• There is only one device template available for Gateway in each Device Template.
• After the Gateway template is created, WAN configurations of the bound sites will be overwritten by the configurations in the template, including Online Detection, WAN Port status, Load Balancing configurations, etc.

 

 

Step 4 (Optional). Tap the “Edit” button in the ACTION column of the relevant template items, then set up “Ports” and “Config” in this device’s properties window based on your needs.

 

 

Step 5. Now you have successfully created this Site Template which is called mytest. If you want to apply this template to the actual sites in this Controller, please go to the next chapter How to bind the sites to Site Template.

 

How to bind the sites to Site Template

According to the chronological sequence of the creation time of the site and the site template, there are two ways for you to bind the site to the site template: the first is to create a site template and then bind it to the existing sites, the second is to choose and apply a specified site template when creating a new site.

Configuration for the existing sites

Go to Global View’s Site Template, click the “Bound Site List” button and then tap the “+ Bind New Site” to select the target sites you want to bind, finally click the “Confirm” button.

Note: After clicking the “Confirm” button, this template’s configuration will be immediately synchronized to the bound sites.

 

 

 

Configuration when creating a new site

Go to Global View’s Dashboard, click the “+ Add New Site” and select “Through Template” as Created Method, then complete the other items in this page and click the “Apply” button.

 

How to bind the devices to Device Template

If you want to bind some devices to a device template to make them work in the same way, please enter the Device Template module of this Site Template, then:

• For Omada Gateway: If there is an Omada Gateway managed in the site, it will be automatically bound to the gateway Device Template after this site is bound to certain Site Template, i.e. the “AUTO BIND” will be enabled and the “STATUS” will be set to “Completed” by default. For example. in this article, ER7206 v1.0 in the 001 site will be bound to the ER_01 template. If you don’t want the ER7206 v1.0 bind with the ER_01 template, just please click the “Edit” and select this model to tap the “unbind” button.

Note: You can only configure the Internet if the Gateway Device Template is created.

 

 

• For Omada Switch: Adjust the “STATUS” to “Completed” from “Draft” firstly, otherwise, we’re not allowed to bind devices to it. Then, click the “Edit” button and ”+ Bind New Device” button in turn, select the model to tap the “Confirm” button.

Note:

1. 14. When the device template has been bound with the exact model, its “STATUS” does not support to be change to “Draft” anymore.
   14. With “AUTO BIND” enabled, the devices with the same model will automatically bind the template and use template configurations. If the configurations are incorrect, the network will be disconnected.
   14. To enable “AUTO BIND”, the template should meet any of the following requirements:
       1. The switch template is not configured with static IP or DHCP server in VLAN Interface > Manage VLAN > IP Address Mode.
       2. The switch template is configured with static IP or DHCP server in VLAN Interface > Manage VLAN > IP Address Mode, and there is at most 1 device of this model in the site.

 

 

Step 3 (Optional). Go to the site 001 bound with mytest template, and we can see that it has been marked with “Site Template: mytest” at the lower left corner of this page. Click the SG2008P bound with SG_01 template, it’s also marked with “This device is using template SG_01.”

 

Step 4 (Optional): If you don’t want multiple sites applied to the same device template to be exactly consistent, you can override the sites and devices’ configuration as you’d like. For example, here we enable the WAN/LAN1 port to be the 3^rd WAN port which doesn’t match the mytest template, then this site will be marked with “Override: Settings have been modified and will not sync from the template mytest.” in the top of this page.

 

 

How to unbind the sites to Site Template

After being unbound with the Site Template, the selected sites will no longer synchronize configurations from the template but can retain the current configurations (including local overrides). Depending on the number of unbound target sites, you can operate in the following two ways:

1) Unbind all/partial sites to the specific Site Template

Go to Global View’s Site Template, click the “Bound Site List” button and then select the target sites you want to unbind, finally tap the “Batch Unbind” button.

 

2) Unbind one site to the specific Site Template

Go to Global View’s Site Template, click the “Bound Site List” button and then select the target site you want to unbind, finally tap the “Unbind” button.

 

How to unbind the devices to Device Template

After completing the unbind operations, those devices will no longer synchronize configurations from the device template but can retain the current configurations (including local overrides). Depending on the number of unbound target sites, you can operate in the following two ways:

1) Unbind all/partial devices to the specific Device Template

 

2) Unbind one device to the specific Device Template

There are two methods for you to unbind one device to the specific Device Template on Omada Controller, one is configured in the Site Template and the other in the actual site.

• Method 1: Configuration in the Site Template

Enter the mytest template, click the “Bound Site List” button of the device template you’d like to operate, tick the target device and tap the “Unbind” button.

 

• Method 2: Configuration in the actual site

Enter the actual site’s Devices module, click the target device to open its properties window and tap the “Unbind Template” button.

 

 

Verification

Here's just a few examples of how it works when Site Template feature is configured, if you're interested you can explore it in more detail on your own.

Step 1. Inheriting the configurations of “How to set up Site Template and Device Template”, we configure the Internet settings for mytest template as the following figures show: Two Interfaces (Default for VLAN 1-192.168.0.1/24 and Site_Template_LAN for VLAN 10-192.168.10.1/24). LAN1 Port’s PVID is set as VLAN 10 for ER_01 template.

 

 

 

Step 2. Go to site 001, we can notice that its Internet settings and gateway’s settings are already the same as in mytest template and ER_01 template separately.

 

 

Step 3. If we modify the LAN settings in site 001 by adding one new interface (!!!!override for VLAN 20-192.168.20.1/23), then this LAN Profile will be marked with “Custom”.

 

 

 

Step 4. After we click the “Re-Apply” button for this site, then all the settings of site 001 will revert back to the same as mytest template.

 

Conclusion

The above is the entire configuration and verification introductions of Site Template function, please configure it according to your actual needs.

Get to know more details of each function and configuration please go to Download Center to download the manual of your product.

FAQ

1. What modules does Site Template feature support to configure, and which are mandatory/optional/unsupported?

Re. Please see the table below.

No	Module	Support	Mandatory	Only for Omada Pro Controller
1	Dashboard	×		×
2	Statistics	×		×
3	Devices	√	√	×
4	Clients	×		×
5	Insights	×		×
6	Logs	√	×	×
7	Audit Logs	√	×	×
8	Health	×		√
9	Abnormal	√	×	√
10	Reports	×		×
11	Map	×		×
12	Network Tools	×		×
13	Site Settings	√	√	×
14	Internet	√	√	×
15	Virtual WAN	×		×
16	LAN	√	√	×
17	WLAN	√	√	×
18	WLAN Optimization	√	×	×
19	SIM	√	×	×
20	ACL	√	√	×
21	URL Filtering	√	√	×
22	MAC Filtering	√	√	×
23	Attack Defense	√	√	×
24	Firewall	√	×	×
25	IP-MAC Binding	×		×
26	Wireless IDS/IPS	√	×	√
27	IDS/IPS	√	√	×
28	Application Control	×		×
29	Routing	√	√	×
30	Switch OSPF	×		×
31	NAT	√	√	×
32	Session Limit	√	√	×
33	Bandwidth Control	√	√	×
34	Gateway Qos	√	√	×
35	Switch Qos	×		×
36	VRRP	×		×
37	OUI Based VLAN	√	√	√
38	VPN	×		×
39	DHCP Reservation	×		×
40	Dynamic DNS	√	√	×
41	mDNS	√	√	×
42	SNMP	√	√	×
43	UPnP	√	√	×
44	SSH	√	√	×
45	Reboot Schedule	√	×	×
46	Port Schedule	√	×	×
47	IPTV	√	√	×
48	DNS Proxy	√	√	×
49	DNS Cache	√	√	×
50	Auto Send Data to Email	×		×
51	Portal	√	√	×
52	802.1X	×		×
53	MAC-Based Authentication	√	√	×
54	Groups	√	√	×
55	Time Range	√	√	×
56	Rate Limit	√	√	×
57	PPSK	√	√	×
58	RADIUS Profile	√	√	×
59	LDAP Profile	√	√	×
60	APN Profile	√	√	×
61	Gateway Qos Service	√	√	×
62	Bonjour Service	√	√	×
63	OUI Profile	√	√	√
64	Site CLI	√	×	×
65	Device CLI	×		×

2. How many site templates and device templates can be created on the same Omada Controller?

Re. For one Omada Controller, the maximum number of Site Template is 100 per customer(For MSP Mode)/Controller, the maximum number of Device Template is 257 (256 for Switch and 1 for Gateway) per Site Template.

3. What should I do if I want the sites bound to a site template but overridden to revert back to the original Site Template?

Re.

• If you want to revert all sites bound to the specific template, you can go to Global View’s Site Template and click the “Re-apply” button directly.
• If you want to revert partial sites bound to the specific template, you can go to Global View’s Site Template, and click the “Bound Site List” button, then tick the desired sites and tap the “Batch Re-Apply” button.
• If you want to revert one site bound to the specific template, you can go to Global View’s Site Template, and click the “Bound Site List” button, then tick the desired site and tap the “Re-Apply” button.

Note:

This operation will overwrite all site-level configurations of the selected sites, overwrite private configurations of the devices whose models are specified in the template, and may clear the configurations that the template does not support. Therefore, if there are custom LAN networks on the site, they will also be deleted, which may cause devices offline or network abnormalities.

Related Articles

Getting started with an Omada Controller

How to Migrate an Omada Controller using the Migration Feature