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
VirtualTemplateManager Class Reference

VirtualTemplateManager manages and manipulates virtual template interfaces for PPPoE. More...

Inheritance diagram for VirtualTemplateManager:
Process

Public Member Functions

VirtualTemplateInterface addVirtualTempIntByNum (int)
 Adds a virtual template interface. More...
 
void removeVirtualTempByNum (int)
 Removes the virtual template interface with the specified interface number. More...
 
VirtualTemplateInterface getVirtualTempIntByNum (int)
 Returns the virtual template interface with the specified interface number. More...
 
int getIntCount ()
 Returns the number of virtual template interfaces. More...
 
VirtualTemplateInterface getIntAt (int)
 Returns the virtual template interface at the specified index. More...
 
void addVpdnGroupByName (string)
 Adds a VPDN group. More...
 
void removeVpdnGroupByName (string)
 Removes the VPDN group with the specified name. More...
 
VpdnGroup getVpdnGroupByName (string)
 Returns the VPDN group with the specified name. More...
 
int getVpdnGroupCount ()
 Returns the number of VPDN groups. More...
 
VpdnGroup getVpdnGroupAt (int)
 Returns the VPDN group at the specified name. More...
 
void setVpdnEnable (bool)
 Enables or disables VPDN. More...
 
bool isVpdnEnable ()
 Returns true if VPDN is enabled, otherwise false. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

VirtualTemplateManager manages and manipulates virtual template interfaces for PPPoE.

Member Function Documentation

◆ addVirtualTempIntByNum()

VirtualTemplateInterface VirtualTemplateManager::addVirtualTempIntByNum ( int  )

Adds a virtual template interface.

Parameters
number,theinterface number for the virtual template interface.

◆ addVpdnGroupByName()

void VirtualTemplateManager::addVpdnGroupByName ( string  )

Adds a VPDN group.

Parameters
name,thename for the VPDN group.

◆ getIntAt()

VirtualTemplateInterface VirtualTemplateManager::getIntAt ( int  )

Returns the virtual template interface at the specified index.

Parameters
number,theindex of the virtual template interface of interest.
Returns
VirtualTemplateInterface, the VirtualTemplateInterface object at the specified index.

◆ getIntCount()

int VirtualTemplateManager::getIntCount ( )

Returns the number of virtual template interfaces.

Returns
int, the number of virtual template interfaces.

◆ getVirtualTempIntByNum()

VirtualTemplateInterface VirtualTemplateManager::getVirtualTempIntByNum ( int  )

Returns the virtual template interface with the specified interface number.

Parameters
number,theinterface number of the virtual template interface of interest.
Returns
VirtualTemplateInterface, the VirtualTemplateInterface object with the specified interface number.

◆ getVpdnGroupAt()

VpdnGroup VirtualTemplateManager::getVpdnGroupAt ( int  )

Returns the VPDN group at the specified name.

Parameters
index,theindex of the VPDN group of interest.
Returns
VpdnGroup, the VpdnGroup object at the specified name.

◆ getVpdnGroupByName()

VpdnGroup VirtualTemplateManager::getVpdnGroupByName ( string  )

Returns the VPDN group with the specified name.

Parameters
name,thename of the VPDN group of interest.
Returns
VpdnGroup, the VpdnGroup object with the specified name.

◆ getVpdnGroupCount()

int VirtualTemplateManager::getVpdnGroupCount ( )

Returns the number of VPDN groups.

Parameters
int,thenumber of VPDN groups.

◆ isVpdnEnable()

bool VirtualTemplateManager::isVpdnEnable ( )

Returns true if VPDN is enabled, otherwise false.

Returns
bool, true if VPDN is enabled, otherwise false.

◆ removeVirtualTempByNum()

void VirtualTemplateManager::removeVirtualTempByNum ( int  )

Removes the virtual template interface with the specified interface number.

Parameters
number,theinterface number of the virtual template interface of interest.

◆ removeVpdnGroupByName()

void VirtualTemplateManager::removeVpdnGroupByName ( string  )

Removes the VPDN group with the specified name.

Parameters
name,thename of the VPDN group of interest.

◆ setVpdnEnable()

void VirtualTemplateManager::setVpdnEnable ( bool  )

Enables or disables VPDN.

Parameters
flag,trueto enable VPDN, false to disable it.

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