Guide de configuration CLI pour Omada SDN Controller (v5.9.9 et supérieur)
08-08-2023À partir de la version 5.9, Omada SDN Controller prend en charge la fonctionnalité de configuration CLI, qui vous permet de créer et d'émettre des profils de configuration à l'aide de la CLI. Cette fonctionnalité est conçue comme une approche complémentaire lorsque certaines fonctionnalités ou certains paramètres ne sont pas disponibles sur l'interface graphique.
Omada SDN Controller prend en charge deux types de configuration CLI : Site CLI et Device CLI.
■ Site CLI : les profils de configuration seront émis pour tous les périphériques prenant en charge la configuration CLI
■ Device CLI : les profils de configuration seront délivrés aux périphériques sélectionnés qui prennent en charge la configuration CLI.
Actuellement, seuls les commutateurs Omada prennent en charge la configuration CLI. Pour plus d'informations sur les commandes CLI pour les commutateurs Omada, veuillez consulter le Guide de référence CLI .
Avant d'utiliser la configuration CLI, assurez-vous de lire attentivement les précautions suivantes et le Guide de l'utilisateur pour éviter toute erreur inattendue. Si vous rencontrez des problèmes, vous pouvez contacter le support technique de TP-Link.
1. Précautions
1.1 Précautions générales
1. La configuration de l'interface graphique et de l'interface de ligne de commande doit être planifiée globalement en fonction de la topologie et des exigences réelles du réseau.
2. Veuillez ne pas utiliser la configuration CLI pour configurer les fonctions qui sont déjà disponibles sur l'interface graphique, car cela peut provoquer des conflits et rendre les paramètres des appareils incohérents avec vos attentes.
un. Lors de l'adoption d'un nouveau périphérique, le contrôleur appliquera des configurations au périphérique dans l'ordre de l'interface graphique, de la CLI du site, puis de la CLI du périphérique. En cas de conflit de configuration, la configuration appliquée en dernier prend effet.
b. Les profils CLI (y compris les profils Site CLI et les profils Device CLI) ne seront délivrés aux appareils qu'une seule fois après leur application, à moins que le bouton "Appliquer à nouveau" dans le résultat de l'application ne soit cliqué pour déclencher l'application de configuration complète.
c. Lorsqu'un périphérique met à niveau son micrologiciel, le contrôleur applique les configurations complètes au périphérique dans l'ordre de l'interface graphique, de la CLI du site, puis de la CLI du périphérique.
d. Veuillez noter que la dernière configuration peut remplacer la configuration précédente, ce qui entraîne différentes configurations d'exécution pour différents périphériques après que la même fonction a été modifiée plusieurs fois via l'interface graphique, la CLI du site ou la CLI du périphérique.
3. Omada Controller ne vérifiera pas les configurations GUI et CLI existantes des appareils. Assurez-vous de vérifier les configurations existantes avant d'effectuer de nouvelles configurations. Sinon, des résultats inattendus peuvent se produire après l'application des configurations et les appareils peuvent même se déconnecter.
4. Pour éviter les conflits de configuration, si vous devez configurer une fonctionnalité à l'aide de la CLI, il est recommandé de ne pas la configurer via l'interface graphique en même temps.
5. Pour éviter la déconnexion des périphériques du contrôleur en raison d'erreurs de configuration ou de conflits, il est recommandé de configurer les VLAN, les interfaces VLAN, les adresses IP, les ACL, etc. uniquement via l'interface graphique et d'éviter de modifier les configurations pertinentes via la CLI.
1.2 Commandes sans effet
Veuillez noter que certaines commandes peuvent ne pas fonctionner correctement en raison de l'allocation des ressources matérielles en mode Contrôleur. Même si les profils CLI contenant ces commandes peuvent être correctement émis et répertoriés dans la configuration en cours d'exécution, ils peuvent ne pas prendre effet car le périphérique ne dispose pas de ressources matérielles pour les exécuter.
Les commandes CLI des modules de fonction suivants ne peuvent pas être configurées ou prendre effet, et doivent être évitées :
- Protocole VLAN
- L2PT
- ERP
- MAC/IP/Contenu du paquet/ACL IPv6
- IMPB IPv4
- IMPB IPv6
- Filtre DHCPv4
- Filtre DHCPv6
- Défense DoS
- Système
- Information système
- Le temps du système
- DIRIGÉ
- PoE
- Intervalle de temps
- Fonctionnalités L2
- Configuration des ports
- Isolement des ports
- Détection de bouclage
- DÉCALAGE
- VLAN, sauf protocole VLAN
- Multidiffusion
- Spanning Tree
- LLDP
- PPPoE ID Insertion
- L3 Features
- IPv4 Routing
- ARP
- Interface
- DHCP
- QoS
- Class of Service
- Scheduler Settings
- Bandwidth Control
- Voice VAN
- Auto VoIP
- Security
- Access Control
- SSH/HTTPS/HTTP/Telnet/Serial Port Config
- AAA
- 802.1X
- Port Security
- Maintenance
- Port Mirroring
- sFlow
- Ethernet OAM
- DLDP
- SNMP
When the same function is configured via CLI multiple times, the previous configuration may be overwritten, and the last configuration shall prevail.
a. It is recommended to confirm the currently effective commands via the CLI configuration viewing function “Show Running Config”.
b. If you need to cancel a certain configuration, use the “no” command.
c. If you need to modify a certain configuration, you can enter a new command to overwrite the configuration.
d. Apply the final configuration, and confirm that the function is configured correctly and takes effect via the CLI configuration viewing function.
If a CLI command fails to be executed, an error will be reported and subsequent commands will be executed. You can view the error details via the error message, and the commands that have been successfully executed before will not be undone. It is recommended to follow the steps below:
a. Use the CLI configuration viewing function (Show Running Config) to confirm the commands that have taken effect. If you need to cancel them, you can enter “no” commands and apply them to devices.
b. Troubleshoot and correct the command error, regenerate the CLI configuration, and apply it to devices.
If you need to modify the commands issued via CLI, please follow the steps below:
a. Use the CLI configuration view function (Show Running Config) to confirm the commands that have taken effect, and sort out the commands that need to be canceled.
b. Enter “no” commands to cancel the configurations, and apply them to devices.
CLI commands such as modifying username and password, managing VLAN, SDM profile, reboot, reset, upgrade, import, and export configurations have been prohibited. When using other CLI commands, please also pay attention to avoid affecting the management of the Controller.
2. Site CLI
Overview
Site CLI enables batch configurations of all devices that support CLI configuration on the site via command lines.
Configuration
1. Go to Settings > CLI Configuration > Site CLI.
2. Click Create New Site CLI Profile and create a CLI profile according to your needs.
Note:
|
• The # character is a special command, which indicates entering the configure mode. Please use it in a separate line. If you add other commands after it in the same line, they will be ignored. • If a command starts with the ! character, the command will be ignored. |
|
Name |
Specify the name of the CLI profile. |
|
Description |
(Optional) Enter a description for identification. |
|
CLI |
Enter the command lines manually. |
|
Import CLI from Device |
Click and select a device that supports CLI configuration to import its running config. |
|
Import CLI from File |
Click and select an existing command file to import command lines. |
3. Click Save to add the profile. The new profile is in inactive state and will not be applied to devices.
4. Click Apply to apply the CLI. The profile will change to active state and apply configurations to all devices that support CLI configuration on the site.
Note:
|
Once the profile becomes active, you will be unable to edit it. |
To check whether the profile is successfully applied to devices and takes effect, click View CLI Details to view the configuration results on the Devices > Application Result page.
Note:
|
Deleting a CLI profile will not take effect on existing configurations on devices. To delete the configurations, use the “no” command. |
3. Device CLI
Overview
Device CLI enables batch configuration of specific devices via command lines.
Device CLI supports variables. You can use the %x% format to define a variable x, and then set different values for different switches. When the Controller applies the Device CLI configuration to switches, it will automatically modify the variable %x% to the values you set.
Configuration
1. Go to Settings > CLI Configuration > Device CLI. Click Create New Device CLI Profile and create a CLI profile according to your needs.
Note:
|
•The # character is a special command, which indicates entering the configure mode. Please use it in a separate line. If you add other commands after it in the same line, they will be ignored. •If a command starts with the ! character, the command will be ignored. |
|
Name |
Specify the name of the CLI profile. |
|
Description |
(Optional) Enter a description for identification. |
|
CLI |
Enter the command lines manually. You can enter %xxx% in the CLI template to define variables. |
|
Import CLI from Device |
Click and select a device that supports CLI configuration to import its running config. |
|
Import CLI from File |
Click and select an existing command file to import command lines. |
2. Cliquez sur Suivant . Sélectionnez les périphériques pour appliquer le profil CLI.
3. Cliquez sur Enregistrer pour ajouter le profil. Le nouveau profil est à l'état inactif et ne sera pas appliqué aux appareils.
4. Cliquez sur Appliquer pour appliquer la CLI. Le profil passera à l'état actif et appliquera les configurations aux appareils que vous avez sélectionnés.
Note:
|
Une fois le profil activé, vous ne pourrez plus le modifier. |
Pour vérifier si le profil est correctement appliqué aux appareils et prend effet, cliquez sur Afficher les détails de l'interface de ligne de commande pour afficher les résultats de la configuration sur la page Appareils > Résultat de l'application .
Note:
|
La suppression d'un profil CLI n'aura pas d'effet sur les configurations existantes sur les appareils. Pour supprimer les configurations, utilisez la commande "no". |
