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

NatProcess handles and manipulates the NAT process. More...

Inheritance diagram for NatProcess:
Process AsaNatProcess AsaNatv6Process

Public Member Functions

bool addNatPool (string)
 Adds a NAT pool with the specified name. More...
 
NatPool getNatPool (string)
 Returns the NAT pool with the specified name. More...
 
NatPool getNatPoolAt (int)
 Returns the NAT pool at the specified index. More...
 
bool removeNatPool (string)
 Removes the NAT pool with the specified name. More...
 
int getNatPoolCount ()
 Returns the number of NAT pools. More...
 
int getInSrcStaticCount ()
 Returns the number of inside source static entries. More...
 
int getOutSrcStaticCount ()
 Returns the number of outside source static entries. More...
 
NatEntry getInSrcStaticAt (int)
 Returns the inside source static entry at the specified index. More...
 
NatEntry getOutSrcStaticAt (int)
 Returns the inside source static entry at the specified index. More...
 
void clearAllTranslations ()
 Clears all NAT translations. More...
 
bool removeInSrcList (string)
 Removes the inside source list entry with the specified ACL ID. More...
 
bool removeOutSrcList (string)
 Removes the outside source list entry with the specified ACL ID. More...
 
NatList getInSrcList (string)
 Returns the inside source list entry with the specified ACL ID. More...
 
NatList getOutSrcList (string)
 Returns the outside source list entry with the specified ACL ID. More...
 
NatList getInSrcListAt (int)
 Returns the inside source list entry at the specified index. More...
 
NatList getOutSrcListAt (int)
 Returns the outside source list entry at the specified index. More...
 
int getInSrcListCount ()
 Returns the number of inside source list entries. More...
 
int getOutSrcListCount ()
 Returns the number of outside source list entries. More...
 
NatTable getNatTable ()
 Returns the NAT table. More...
 
void updateTableEvent ()
 Event triggered when the table is updated. More...
 
void closeTableEvent ()
 Event triggered when the table is closed, deleted. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

NatProcess handles and manipulates the NAT process.

Member Function Documentation

◆ addNatPool()

bool NatProcess::addNatPool ( string  )

Adds a NAT pool with the specified name.

Parameters
poolName,thename for the NAT pool.
Returns
bool, true if successful, otherwise false.

◆ clearAllTranslations()

void NatProcess::clearAllTranslations ( )

Clears all NAT translations.

◆ closeTableEvent()

void NatProcess::closeTableEvent ( )

Event triggered when the table is closed, deleted.

IPC event.

◆ getInSrcList()

NatList NatProcess::getInSrcList ( string  )

Returns the inside source list entry with the specified ACL ID.

Parameters
aclId,theID of the ACL of interest.
Returns
NatEntry, the NatEntry object with the specified ACL ID.

◆ getInSrcListAt()

NatList NatProcess::getInSrcListAt ( int  )

Returns the inside source list entry at the specified index.

Parameters
index,theindex of the inside source list entry of interest.
Returns
NatEntry, the NatEntry object at the specified index.

◆ getInSrcListCount()

int NatProcess::getInSrcListCount ( )

Returns the number of inside source list entries.

Returns
int, the number of inside source list entries.

◆ getInSrcStaticAt()

NatEntry NatProcess::getInSrcStaticAt ( int  )

Returns the inside source static entry at the specified index.

Parameters
index,theindex of the inside source static entry of interest.
Returns
NatEntry, the NatEntry object at the specified index.

◆ getInSrcStaticCount()

int NatProcess::getInSrcStaticCount ( )

Returns the number of inside source static entries.

Returns
int, the number of inside source static entries.

◆ getNatPool()

NatPool NatProcess::getNatPool ( string  )

Returns the NAT pool with the specified name.

Parameters
poolName,thename of the NAT pool of interest.
Returns
NatPool, the NatPool object with the specified name.

◆ getNatPoolAt()

NatPool NatProcess::getNatPoolAt ( int  )

Returns the NAT pool at the specified index.

Parameters
index,theindex of the NAT pool of interest.
Returns
NatPool, the NatPool object at the specified index.

◆ getNatPoolCount()

int NatProcess::getNatPoolCount ( )

Returns the number of NAT pools.

Returns
int, the number of NAT pools.

◆ getNatTable()

NatTable NatProcess::getNatTable ( )

Returns the NAT table.

Returns
NatTable, the NatTable object.

◆ getOutSrcList()

NatList NatProcess::getOutSrcList ( string  )

Returns the outside source list entry with the specified ACL ID.

Parameters
aclId,theID of the ACL of interest.
Returns
NatEntry, the NatEntry object with the specified ACL ID.

◆ getOutSrcListAt()

NatList NatProcess::getOutSrcListAt ( int  )

Returns the outside source list entry at the specified index.

Parameters
index,theindex of the outside source list entry of interest.
Returns
NatEntry, the NatEntry object at the specified index.

◆ getOutSrcListCount()

int NatProcess::getOutSrcListCount ( )

Returns the number of outside source list entries.

Returns
int, the number of outside source list entries.

◆ getOutSrcStaticAt()

NatEntry NatProcess::getOutSrcStaticAt ( int  )

Returns the inside source static entry at the specified index.

Parameters
index,theindex of the inside source static entry of interest.
Returns
NatEntry, the NatEntry object at the specified index.

◆ getOutSrcStaticCount()

int NatProcess::getOutSrcStaticCount ( )

Returns the number of outside source static entries.

Returns
int, the number of outside source static entries.

◆ removeInSrcList()

bool NatProcess::removeInSrcList ( string  )

Removes the inside source list entry with the specified ACL ID.

Parameters
aclId,theID of the ACL of interest.
Returns
bool, true if successful, otherwise false.

◆ removeNatPool()

bool NatProcess::removeNatPool ( string  )

Removes the NAT pool with the specified name.

Parameters
poolName,thename of the NAT pool.
Returns
bool, true if successful, otherwise false.

◆ removeOutSrcList()

bool NatProcess::removeOutSrcList ( string  )

Removes the outside source list entry with the specified ACL ID.

Parameters
aclId,theID of the ACL of interest.
Returns
bool, true if successful, otherwise false.

◆ updateTableEvent()

void NatProcess::updateTableEvent ( )

Event triggered when the table is updated.

IPC event.


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