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

NFExporter handles and manipulates NetFlow exporters. More...

Inheritance diagram for NFExporter:
Process

Public Member Functions

NFTemplate getTemplateById (int)
 Returns the NetFlow template with the specified ID. More...
 
NFTemplate getTemplateByRecordName (string)
 Returns the NetFlow template with the specified record name. More...
 
bool removeTemplate (int)
 Removes the NetFlow template with the specified ID. More...
 
void setExporterName (string)
 Sets the name for the NetFlow exporter. More...
 
string getExporterName ()
 Returns the name of the NetFlow exporter. More...
 
void setExporterVersion (int)
 Sets the version for the NetFlow exporter. More...
 
int getExporterVersion ()
 Returns the version of the NetFlow exporter. More...
 
long getDeviceUpTime ()
 Returns the device up time. More...
 
bool isFullyConfigured ()
 Returns true if the NetFlow exporter is fully configured, otherwise false. More...
 
void setSrcPort (string)
 Sets the source port. More...
 
Port getSrcPort ()
 Returns the source port. More...
 
void setDestinationAddr (ip)
 Sets the destination IP address. More...
 
ip getDestinationAddr ()
 Returns the destination IP address. More...
 
void setDestinationUdpPort (int)
 Sets the destination UDP port number. More...
 
int getDestinationUdpPort ()
 Returns the destination UDP port number. More...
 
void addMonitor (string)
 Adds a monitor with the specified name. More...
 
void removeMontior (string)
 Removes the monitor with the specified name. More...
 
FrameInstance createFrameInstance ()
 Creates a frame instance. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

NFExporter handles and manipulates NetFlow exporters.

Member Function Documentation

◆ addMonitor()

void NFExporter::addMonitor ( string  )

Adds a monitor with the specified name.

Parameters
monitorName,thename for the monitor.

◆ createFrameInstance()

FrameInstance NFExporter::createFrameInstance ( )

Creates a frame instance.

Returns
FrameInstance, the FrameInstance object of the frame instance.

◆ getDestinationAddr()

ip NFExporter::getDestinationAddr ( )

Returns the destination IP address.

Returns
ip, the IP address of the destination.

◆ getDestinationUdpPort()

int NFExporter::getDestinationUdpPort ( )

Returns the destination UDP port number.

Returns
int, the UDP port number of the destination.

◆ getDeviceUpTime()

long NFExporter::getDeviceUpTime ( )

Returns the device up time.

Returns
int, the device up time.

◆ getExporterName()

string NFExporter::getExporterName ( )

Returns the name of the NetFlow exporter.

Returns
string, the name of the NetFlow exporter.

◆ getExporterVersion()

int NFExporter::getExporterVersion ( )

Returns the version of the NetFlow exporter.

Returns
int, the version of the NetFlow exporter.

◆ getSrcPort()

Port NFExporter::getSrcPort ( )

Returns the source port.

Returns
Port, the Port object of the source port.

◆ getTemplateById()

NFTemplate NFExporter::getTemplateById ( int  )

Returns the NetFlow template with the specified ID.

Parameters
id,theID of the NetFlow template of interest.
Returns
NFTemplate, the NFTemplate object with the specified ID.

◆ getTemplateByRecordName()

NFTemplate NFExporter::getTemplateByRecordName ( string  )

Returns the NetFlow template with the specified record name.

Parameters
recordName,therecord name of the NetFlow template of interest.
Returns
NFTemplate, the NFTemplate object with the specified record name.

◆ isFullyConfigured()

bool NFExporter::isFullyConfigured ( )

Returns true if the NetFlow exporter is fully configured, otherwise false.

Returns
bool, true if the NetFlow exporter is fully configured, otherwise false.

◆ removeMontior()

void NFExporter::removeMontior ( string  )

Removes the monitor with the specified name.

Parameters
monitorName,thename of the monitor of interest.

◆ removeTemplate()

bool NFExporter::removeTemplate ( int  )

Removes the NetFlow template with the specified ID.

Parameters
templateId,theID of the NetFlow template of interest.
Returns
bool, true if successful, otherwise false.

◆ setDestinationAddr()

void NFExporter::setDestinationAddr ( ip  )

Sets the destination IP address.

Parameters
ip_add,theIP address of the destination.

◆ setDestinationUdpPort()

void NFExporter::setDestinationUdpPort ( int  )

Sets the destination UDP port number.

Parameters
port,theUDP port number for the destination.

◆ setExporterName()

void NFExporter::setExporterName ( string  )

Sets the name for the NetFlow exporter.

Parameters
name,thename for the NetFlow exporter.

◆ setExporterVersion()

void NFExporter::setExporterVersion ( int  )

Sets the version for the NetFlow exporter.

Parameters
version,theversion for the NetFlow exporter.

◆ setSrcPort()

void NFExporter::setSrcPort ( string  )

Sets the source port.

Parameters
port,portNamecan 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

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