Router Class Reference

Router is the base class for all router devices. More...

Inheritance diagram for Router:

Public Member Functions
bool	addSubInt (string, int)
	Adds a subinterface to the specified port. More...
bool	removeSubInt (string)
	Removes the subinterface from the specified port. More...
bool	changePortEncapsulation (string, string)
	Changes the encapsulation on the specified port. More...
void	addUserPass (string, string, int)
	Adds a user account. More...
void	removeUserPass (string)
	Removes the specified user account. More...
string	getUserPass (string)
	Returns the password of the specified username. More...
int	getUserPassCount ()
	Returns the number of user accounts. More...
ClassMapManager	getClassMapManager ()
	Returns the class map manager. More...
PolicyMapManager	getPolicyMapManager ()
	Returns the policy map manager. More...
ParameterMapManager	getParameterMapManager ()
	Returns the parameter map manager. More...
FlowMonitorManager	getNetflowMonitorManager ()
	Returns the flow monitor manager. More...
FlowRecordManager	getNetflowRecordManager ()
	Returns the flow record manager. More...
NFExporterManager	getNetflowExporterManager ()
	Returns the NetFlow exporter manager. More...
Public Member Functions inherited from CiscoDevice
void	setHostName (string)
	Sets the hostname of this device with the specified string. More...
string	getHostName ()
	Returns the hostname of this device. More...
void	setEnableSecret (string)
	Sets the encrypted enable secret password with the specified string. More...
string	getEnableSecret ()
	Returns the encrypted enable secret string. More...
void	setEnablePassword (string, int)
	Sets the enable password. More...
string	getEnablePassword ()
	Returns the enable password. More...
void	setStartupFile (string)
	Sets the startup file to the specified file. More...
vector< string >	getStartupFile ()
	Returns the contents of the current startup file. More...
bool	addBootSystem (string)
	Modifies the system parameters to add a particular boot system image. More...
bool	removeBootSystem (string)
	Removes the specified boot system from this device. More...
void	removeAllBootSystem ()
	Removes all boot system images from this device. More...
vector< BootSystemEntry >	getBootSystems ()
	Returns the list of current boot system images. More...
short	getConfigRegister ()
	Returns the current config register. More...
void	setNextConfigRegister (short)
	Sets the next config register. More...
short	getNextConfigRegister ()
	Returns the next config register. More...
void	setBannerMotd (string)
	Sets the message of the day banner when the device boots. More...
string	getBannerMotd ()
	Returns the message of the day banner. More...
void	setTimeZone (string, short, short)
	Sets the timezone for this device. More...
string	getTimeZone ()
	Returns the timezone of this device. More...
mac	getBia ()
	Returns the burned-in address of this device. More...
void	setServicePasswordEncryption (bool)
	Enables or disables service password encryption. More...
bool	getServicePasswordEncryption ()
	Returns true if service password encryption is enabled, otherwise false. More...
Port	getConsole ()
	Returns the console port of this device. More...
TerminalLine	getConsoleLine ()
	Returns the console line of this device. More...
TerminalLine	getVtyLine (int)
	Returns the vty line specified by num. More...
TerminalLine	getLine (int)
	Returns the line specified by num. More...
TerminalLine	getIpcTerminalLine ()
	Returns the IPC terminal line of this device. More...
pair< CommandStatus, string >	enterCommand (string, string)
	Enters the specified command in the specified mode to the terminal. More...
bool	isBooting ()
	Checks whether the device is currently booting. More...
void	skipBoot ()
	Skips the booting process. More...
void	doneBooting ()
	This event is emitted when the device is done booting. More...
void	setFtpUsername (string)
	Sets the FTP username for the device. More...
void	setFtpPasswd (string, int)
	Sets the FTP password for the device. More...
string	getFtpUsername ()
	Returns the FTP username for the device. More...
string	getFtpPasswd ()
	Returns the FTP password for the device. More...
void	clearFtpUsername ()
	Clears the current FTP username. More...
void	clearFtpPasswd ()
	Clears the current FTP password. More...
int	getUserPassCount ()
	Returns the number of authenticated users. More...
void	addUserPassEntry (string, string, int)
	Adds an authenticated user with the specified username, password, and type. More...
void	removeUserPassEntry (string)
	Removes the authenticated user with the specified username. More...
string	getUserEntryAt (int)
	Returns the username of the authenticated user at the specified index. More...
void	removeUserPassAt (int)
	Removes the username of the authenticated user at the specified index. More...
bool	isUserExist (string)
	Returns true if the specified authenticated user exists, otherwise false. More...
void	lineConnected (int, ip, short, LoginMethod)
	This event is emitted when a terminal line has connected. More...
void	lineDisconnected (int)
	This event is emitted when a terminal line has disconnected. More...
void	lineAuthenticationStarted (int, ip, short, LoginMethod)
	This event is emitted when a terminal line has started authentication. More...
void	lineAuthenticationFailed (int)
	This event is emitted when a terminal line failed authentication. More...
void	lineAuthenticationFinished (int, bool)
	This event is emitted when a terminal line finished authentication. More...
void	closeTableEvent ()
	IPC event. More...
Public Member Functions inherited from Device
void	setName (QString)
	Sets the display name of this device. More...
QString	getName ()
	Returns the display name of this device. More...
void	nameChanged (QString, QString)
	IPC event. More...
void	setPower (bool)
	Sets the power on or off. More...
void	addSound (QString, QString)
	Adds sound to the device. More...
void	playSound (QString, int)
	Play sound to the device. More...
void	stopSound (QString)
	Stop playing sound on the device. More...
void	stopSounds ()
	Stops playing all sounds on the device. More...
void	destroySounds ()
	Destroy all of the sounds on the device. More...
bool	getPower ()
	Returns the current power state of this device. More...
double	getXCoordinate ()
	Returns the current x-coordinate position in the Logical workspace for this device. More...
double	getYCoordinate ()
	Returns the current y-coordinate position in the Logical workspace for this device. More...
double	getCenterXCoordinate ()
	Returns the current x-coordinate position in the Logical workspace for this device. More...
double	getCenterYCoordinate ()
	Returns the current y-coordinate position in the Logical workspace for this device. More...
double	getAreaTopY ()
	Returns the current topmost y-coordinate position in the for this device. More...
double	getAreaLeftX ()
	Returns the current leftmost x-coordinate position in the for this device. More...
bool	moveToLocationCentered (int, int)
	Moves this device to the specified location for its center in Logical workspace. More...
bool	moveToLocation (int, int)
	Moves this device to the specified location in Logical workspace. More...
int	getXPhysicalWS ()
	Returns the current x-coordinate position in the Physical workspace for this device. More...
int	getYPhysicalWS ()
	Returns the current y-coordinate position in the Physical workspace for this device. More...
double	getGlobalXPhysicalWS ()
	Returns the current global x-coordinate position in the Physical workspace for this device. More...
double	getGlobalYPhysicalWS ()
	Returns the current global y-coordinate position in the Physical workspace for this device. More...
bool	moveToLocInPhysicalWS (int, int)
	Moves this device to the specified location in Physical workspace. More...
bool	moveByInPhysicalWS (int, int)
	Moves this device by the specified amount in Physical workspace. More...
void	powerChanged (bool)
	IPC event. More...
void	poweringOff ()
	IPC event. More...
DeviceType	getType ()
	Returns the type of this device. More...
string	getModel ()
	Returns the model of this device. More...
DeviceDescriptor	getDescriptor ()
	Returns the device descriptor that user can get information on the device like type, model, module supported.. More...
string	getSerialNumber ()
	Returns the device serial number. More...
Port	getPort (string)
	Returns the Port object with the specified port name. More...
int	getPortCount ()
	Returns the number of ports in this device. More...
Port	getPortAt (int)
	Returns the Port object at the specified index. More...
Process	getProcess (string)
	Returns the Process object associated the process name. More...
int	getUsbPortCount ()
	Return the number of usb port. More...
UsbPort	getUsbPortAt (int)
	Returns the usb port at a specified index. More...
Module	getRootModule ()
	Returns the root module of the device. More...
bool	addModule (string, ModuleType, string)
	Adds a specific module to a particular slot. More...
bool	removeModule (string)
	Removes the module from the slot. More...
void	moduleAdded (ModuleType, string, string)
	This event is emitted when a module is added. More...
void	moduleRemoved (ModuleType, string, string)
	This event is emitted when a module is removed. More...
void	portAdded (string)
	This event is emitted when a port is added. More...
void	portRemoved (string)
	This event is emitted when a port is removed. More...
void	portRemoving (string)
	This event is emitted when a port is being removed but before it is actually removed. This is useful for script modules to clean up things before the port is removed. More...
TerminalLine	getCommandLine ()
	Returns the command line TerminalLine object. More...
void	addCustomVar (QString, QString)
	Adds a custom variable. More...
bool	removeCustomVar (QString)
	Removes a custom variable. More...
bool	hasCustomVar (QString)
	Returns true if this device has a custom variable with the specified name. More...
QString	getCustomVarStr (QString)
	Returns the value of the variable with the specified name. More...
int	getCustomVarsCount ()
	Returns the number of custom variables this device has. More...
QString	getCustomVarNameAt (int)
	Returns the name of the custom variable at the specified index. More...
QString	getCustomVarValueStrAt (int)
	Returns the value of the custom variable at the specified index. More...
void	setCustomInterface (QString)
	Set custom interface to the device. More...
QString	getCustomInterface ()
	Get custom interface name on the device. More...
QString	serializeToXml ()
	Returns the serialization string of this device. More...
QString	activityTreeToXml ()
	Returns the serialization string of this device's activity tree. More...
PhysicalObject	getPhysicalObject ()
	Get custom interface name on the device. More...
QString	getCustomLogicalImage ()
	Get custom logical image path. More...
void	setCustomLogicalImage (QString)
	Set custom logical image path. More...
QString	getCustomPhysicalImage ()
	Get custom physical image path. More...
void	setCustomPhysicalImage (QString)
	Set custom physical image path. More...
vector< string >	getSupportedModule ()
	Get a vector of supported modules. More...
void	setTime (int, int, int, int, int, int)
	Set time to the device. More...
long	getUpTime ()
	Set time to the device. More...
vector< string >	getPorts ()
	Set time to the device. More...
double	getDeviceExternalAttributeValue (string)
	Get device external attribute value. More...
void	setDeviceExternalAttributes (QString)
	Set device external attribute value. More...
void	addDeviceExternalAttributes (QString)
	Add device external attribute value. More...
void	subtractDeviceExternalAttributes (QString)
	Remove some of the device external attribute value pairs from the current list. More...
QString	getDeviceExternalAttributes ()
	Returns the list of external attributes and associated values. More...
void	clearDeviceExternalAttributes ()
bool	isOutdated ()
bool	restoreToDefault (bool, bool)
void	updateTemplateCreationTime ()
bool	runProject (string, string)
	Runs a programming project in the mcu. More...
bool	stopProject (string)
	Stops a programming project in the mcu. More...
bool	isProjectRunning (string)
	Checks if a programming project with the given name is running. More...
bool	runCodeInProject (string, string)
	Runs additional code in the given project. More...
void	addProgrammingSerialOutputs (string)
	Writes to the programming output. Text appears in the programming output dialog. More...
string	getProgrammingSerialOutputs ()
	Gets the programming output. It is the text that appears in the programming output dialog. More...
void	clearProgrammingSerialOutputs ()
	Clears the programming output dialog. More...
UserDesktopAppConfig	addUserDesktopApp (string)
UserDesktopAppConfig	addUserDesktopAppFrom (UserDesktopAppConfig)
UserDesktopAppConfig	addUserDesktopAppFromGlobal (string)
int	getUserDesktopAppCount ()
UserDesktopAppConfig	getUserDesktopAppAt (int)
UserDesktopAppConfig	getUserDesktopAppByDir (string)
UserDesktopAppConfig	getUserDesktopAppById (string)
void	removeUserDesktopApp (string)
void	relinkUserDesktopApp (string, string)
bool	isDesktopAvailable ()

Detailed Description

Router is the base class for all router devices.

Member Function Documentation

addSubInt()

bool Router::addSubInt	(	string	,
		int
	)

Adds a subinterface to the specified port.

Parameters

portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0
subIntNum,the	subinterface number.

addUserPass()

void Router::addUserPass	(	string	,
		string	,
		int
	)

Adds a user account.

Parameters

username,the	username.
password,the	password.
int,the	type.

changePortEncapsulation()

bool Router::changePortEncapsulation	(	string	,
		string
	)

Changes the encapsulation on the specified port.

Parameters

portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0
encapsulationType,the	encapsulation type. Encapsulation types: hdlc, ppp, frameRelay, arpa, dot1Q

Returns

bool, true if successful, otherwise false.

getClassMapManager()

ClassMapManager Router::getClassMapManager

(

)

Returns the class map manager.

Returns

ClassMapManager, the ClassMapManager object.

getNetflowExporterManager()

NFExporterManager Router::getNetflowExporterManager

(

)

Returns the NetFlow exporter manager.

Returns

NFExporterManager, the NFExporterManager object.

getNetflowMonitorManager()

FlowMonitorManager Router::getNetflowMonitorManager

(

)

Returns the flow monitor manager.

Returns

FlowMonitorManager, the FlowMonitorManager object.

getNetflowRecordManager()

FlowRecordManager Router::getNetflowRecordManager

(

)

Returns the flow record manager.

Returns

FlowRecordManager, the FlowRecordManager object.

getParameterMapManager()

ParameterMapManager Router::getParameterMapManager

(

)

Returns the parameter map manager.

Returns

ParameterMapManager, the ParameterMapManager object.

getPolicyMapManager()

PolicyMapManager Router::getPolicyMapManager

(

)

Returns the policy map manager.

Returns

PolicyMapManager, the PolicyMapManager object.

getUserPass()

string Router::getUserPass

(

string

)

Returns the password of the specified username.

Parameters

username,the

username of interest.

Returns

string, the password of the specified username.

getUserPassCount()

int Router::getUserPassCount

(

)

Returns the number of user accounts.

Returns

int, the number of user accounts.

removeSubInt()

bool Router::removeSubInt

(

string

)

Removes the subinterface from the specified port.

Parameters

portName,portName

can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

removeUserPass()

void Router::removeUserPass

(

string

)

Removes the specified user account.

Parameters

username,the

username of interest.

---

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

• CRouter.pki