Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
Vlan Class Reference

Vlan handles and manipulates the individual VLAN. More...

Public Member Functions

string getName ()
 Returns the name of this VLAN. More...
 
MacTable getMacTable ()
 Returns the MAC address table. More...
 
bool isDefault ()
 Returns true if this is the default VLAN, otherwise false. More...
 
int getVlanNumber ()
 Returns the VLAN number of this VLAN. More...
 
void macEntryAdded (mac, string, bool)
 This event is emitted when a MAC address entry is added. More...
 
void macEntryRemoved (mac, string, bool)
 This event is emitted when a MAC address entry is removed. More...
 

Detailed Description

Vlan handles and manipulates the individual VLAN.

Member Function Documentation

◆ getMacTable()

MacTable Vlan::getMacTable ( )

Returns the MAC address table.

Returns
MacTable, the MacTable object.

◆ getName()

string Vlan::getName ( )

Returns the name of this VLAN.

Returns
string, the name of this VLAN.

◆ getVlanNumber()

int Vlan::getVlanNumber ( )

Returns the VLAN number of this VLAN.

Returns
int, the VLAN number of this VLAN.

◆ isDefault()

bool Vlan::isDefault ( )

Returns true if this is the default VLAN, otherwise false.

Returns
bool, true if this is the default VLAN, otherwise false.

◆ macEntryAdded()

void Vlan::macEntryAdded ( mac  ,
string  ,
bool   
)

This event is emitted when a MAC address entry is added.

  • newMac, the new MAC address that was added.
  • portName, the name of the associated port.
  • isDynamic, true if dynamic, otherwise false.

IPC event.

◆ macEntryRemoved()

void Vlan::macEntryRemoved ( mac  ,
string  ,
bool   
)

This event is emitted when a MAC address entry is removed.

  • newMac, the new MAC address that was removed.
  • portName, the name of the associated port.
  • isDynamic, true if dynamic, otherwise false.

IPC event.


The documentation for this class was generated from the following file: