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

SyslogServer handles and manipulates the Syslog service. More...

Inheritance diagram for SyslogServer:
Process

Public Member Functions

void setEnable (bool)
 Enables or disables the Syslog service. More...
 
bool isEnabled ()
 Returns true if the Syslog service is enabled, otherwise false. More...
 
void setPortNumber (short)
 Sets the port number for the Syslog service. More...
 
short getPortNumber ()
 Returns the port number for the Syslog service. More...
 
void SyslogEntryAdded (SyslogEntry)
 This event is emitted when a new syslog entry is added. More...
 
vector< SyslogEntrygetAllEntries ()
 Returns all Syslog entries. More...
 
void clearAllSysLogEntries ()
 Clear all syslog entries. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

SyslogServer handles and manipulates the Syslog service.

Member Function Documentation

◆ clearAllSysLogEntries()

void SyslogServer::clearAllSysLogEntries ( )

Clear all syslog entries.

◆ getAllEntries()

vector< SyslogEntry > SyslogServer::getAllEntries ( )

Returns all Syslog entries.

Returns
vector of Syslog Entry

◆ getPortNumber()

short SyslogServer::getPortNumber ( )

Returns the port number for the Syslog service.

Returns
short, the port number for the Syslog service.

◆ isEnabled()

bool SyslogServer::isEnabled ( )

Returns true if the Syslog service is enabled, otherwise false.

Returns
bool, true if the Syslog service is enabled, otherwise false.

◆ setEnable()

void SyslogServer::setEnable ( bool  )

Enables or disables the Syslog service.

Parameters
bEnable,trueto enable the Syslog service, false to disable it.

◆ setPortNumber()

void SyslogServer::setPortNumber ( short  )

Sets the port number for the Syslog service.

Parameters
portNum,theport number for the Syslog service.

◆ SyslogEntryAdded()

void SyslogServer::SyslogEntryAdded ( SyslogEntry  )

This event is emitted when a new syslog entry is added.

  • SyslogEntry, the name of the external process source.
  • srcCepInstanceId, the UUID of the external process source.
  • message, the message from the external process source.

IPC event.


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