Arista eAPI - Dynamic VLAN Assignment
Content
Summary
This document provides information about the Arista - Dynamic Vlan Assignment implementation for VSM.
Status of Driver | APPROVED |
---|---|
Component for Driver | GADGETSERVER |
Release (Build) of Component | vsmGadgetserver 5.4.x (2017) |
Revision of Implementation | 1.0 |
Name/Type of 3rd Party API | Arista eAPI |
---|---|
Version of 3rd Party API | 1.0.0.2 |
Additional 3rd Party information |
Connection
Connection Type | TCP/ IP |
---|---|
Default Port |
The stream type must be set to Virtual.
Supported Features
The user can assign a specified switch interface to a specfied vlan via 1:N Matrix.
Supported Commands
Command 1 | enable |
---|---|
Command 2 | configure |
Command 3 | show vlan |
Command 4 | show interfaces description |
Command 5 | interface |
Command 6 | switch access vlan |
Configuration Details
eApi must be enabled on all controlled switches via Terminal commands:
enable |
configure terminal |
management api http-commands |
[no] shutdown |
[no] protocol https [port ] |
[no] protocol http [port ] |
All contolled switches must be configured with identical Vlan indices. Ethernet interfaces must be configured via:
switchport |
switchport mode access |
vsmGadgetserver
Since this protocol is using the Virtual Streamtype, the protocol applies a default value (“Settings”) to the Address field to enable the communication.
At the first stage this protocol needs the uri
, user name
and password
for all controlled Arista switches on the network. Please edit the Switches in the following format:
IpAddress:Port;UserName;Password
The protocol needs a valid Vlan index in option Blind to perform a disconnect.
The option System Mapping holds the mapping file of this protocol wich will be used to map the interfaces(targets)/vlans(sources) to the protocol matrix. Each switch supports up to 64 targets per device. Please download, edit and upload the .xml file.
The configured VLans will be automatically added to the mapping file as sources. For the target mapping the user must enter the used interfaces to the corresponding switch regions:
<indexMappingRegion>
<name>10.1.234.66:80</name>
<offset>0</offset>
<usage>Target</usage>
<children>
<indexMapping>
<identifier>Ethernet3/10</identifier>
<index>0</index>
</indexMapping>
<indexMapping>
<identifier>Ethernet3/11</identifier>
<index>1</index>
</indexMapping>
</children>
</indexMappingRegion>
The <offset> tag defines the switch offset on the matrix multiplied by 64. An ethernet interface must be enclosed by the <indexMapping> tags. <identifier> is the inteface name and <index> is the index on the matrix plus the offset calculation.
Known Issues
Since the protocol must open connections to different devices, we currently cannot provide a useful protocol operation state(Valid,Connected,Disconnected). As soon as the first switch is detected as online, the operation state will switch to valid.