RouterPort handles and manipulates the router port. More...

Inheritance diagram for RouterPort:

Public Member Functions
void	setAclInID (string)
	Sets an inbound ACL. More...

void	setAclOutID (string)
	Sets an outbound ACL. More...

string	getAclInID ()
	Returns the inbound ACL ID. More...

string	getAclOutID ()
	Returns the outbound ACL ID. More...

void	setNatMode (NatMode)
	Sets the NAT mode. More...

NatMode	getNatMode ()
	Returns the NAT mode. More...

void	setCdpEnable (bool)
	Enables or disables CDP. More...

bool	isCdpEnable ()
	Returns true if CDP is enabled, otherwise false. More...

void	setRipPassive (bool)
	Enables or disables RIP passive interface. More...

bool	isRipPassive ()
	Returns true if RIP passive interface is enabled, otherwise false. More...

void	setRipSplitHorizon (bool)
	Enables or disables RIP split horizon. More...

bool	isRipSplitHorizon ()
	Returns true if RIP split horizon is enabled, otherwise false. More...

void	addEntryEigrpPassive (int, bool)
	Enables or disables EIGRP passive interface for the specified AS. More...

void	removeEntryEigrpPassive (int)
	Remvoes EIGRP passive interface for the specified AS. More...

int	getOspfAuthType ()
	Returns the OSPF authentication type. More...

void	setOspfAuthKey (string)
	Sets the OSPF authentication key. More...

string	getOspfAuthKey ()
	Returns the OSPF authentication key. More...

bool	addOspfMd5Key (short, string)
	Adds an OSPF MD5 key. More...

void	removeOspfMd5Key (short)
	Removes the specified OSPF MD5 key. More...

void	setOspfCost (short)
	Sets the OSPF cost. More...

short	getOspfCost ()
	Returns the OSPF cost. More...

void	setOspfDeadInterval (short)
	Sets the OSPF dead interval. More...

short	getOspfDeadInterval ()
	Returns the OSPF dead interval. More...

void	setOspfHelloInterval (short)
	Sets the OSPF hello interval. More...

short	getOspfHelloInterval ()
	Returns the OSPF hello interval. More...

void	setOspfPriority (short)
	Sets the OSPF priority. More...

short	getOspfPriority ()
	Returns the OSPF priority. More...

void	setDelay (int)
	Sets the delay. More...

int	getDelay ()
	Returns the delay. More...

void	setBandwidthInfo (int)
	Sets the bandwidth. More...

int	getBandwidthInfo ()
	Returns the bandwidth. More...

void	resetBandwidth ()
	Resets the bandwidth. More...

void	resetDelay ()
	Resets the delay. More...

void	setIntForAs (short, short)
	Sets the interval for the specified EIGRP AS. More...

short	getIntOfAs (short)
	Returns the interval for the specified EIGRP AS. More...

bool	addSummaryAddress (short, ip, ip, int)
	Adds a summary address for the specified EIGRP AS. More...

bool	removeSummaryAddress (short, ip, ip, int)
	Removes the summary address for the specified EIGRP AS. More...

string	getZoneMemberName ()
	Returns the zone name in which this port belongs. More...

void	setZoneMemberName (string)
	Sets the zone name for this port. More...

void	setIpsInID (string)
	Sets the IPS as inside ID for this port. More...

void	setIpsOutID (string)
	Sets the IPS as outside ID for this port. More...

string	getIpsInID ()
	Returns the IPS inside ID. More...

string	getIpsOutID ()
	Returns the ips outside ID. More...

void	setProxyArpEnabled (bool)
	Enables or disables proxy ARP. More...

bool	isProxyArpEnabled ()
	Returns true if proxy ARP is enabled, otherwise false. More...

bool	isIkeEnabled ()
	Check is Ike is enabled on the port. More...

void	setIkeEnabled (bool)
	Enable or disable Ike on the port. More...

Public Member Functions inherited from HostPort
void	setIpSubnetMask (ip, ip)
	Configures a static IP address and subnet mask on the port. More...

void	setDefaultArpTimeout ()
	Sets the default timer time for ARP. More...

void	setDhcpClientFlag (bool)
	Enables or disables the DHCP client on the port. More...

bool	isDhcpClientOn ()
	Returns true if the DHCP client is enabled, otherwise false. More...

ip	getIpAddress ()
	Returns the IP address configured on the port. More...

ip	getSubnetMask ()
	Returns the subnet mask configured on the port. More...

void	ipChanged (ip, ip, ip, ip)
	This event is emitted when the IP address or subnet mask changes. More...

void	setIpv6Enabled (bool)
	Enables or disables IPv6 on the port. More...

bool	isIpv6Enabled ()
	Returns true if IPv6 is enabled on the port, otherwise false. More...

void	setIpv6AddressAutoConfig (bool)
	Enables or disables IPv6 auto config. More...

bool	isIpv6AddressAutoConfig ()
	Returns true if IPv6 auto config is enabled, otherwise false. More...

bool	isSetToDhcpv6 ()
	Returns true if port is set to DHCP v6, otherwise false. More...

void	setIpv6LinkLocal (ipv6)
	Sets the IPv6 link-local address. More...

ipv6	getIpv6LinkLocal ()
	Returns the IPv6 link-local address. More...

void	ipv6LinkLocalChanged (ipv6, ipv6)
	This event is emitted when the IPv6 link-local address changes. More...

bool	addIpv6Address (ipv6, int, Ipv6AddressType, bool)
	Configures a static IPv6 address and network prefix on the port. More...

void	ipv6AddressAdded (ipv6, int, Ipv6AddressType)
	This event is emitted when the IPv6 address changes. More...

bool	removeIpv6Address (ipv6, int, Ipv6AddressType)
	Removes the IPv6 configuration from the port. More...

void	ipv6AddressRemoved (ipv6, int, Ipv6AddressType)
	This event is emitted when the IPv6 address configuration is removed. More...

void	removeAllIpv6Addresses ()
	Removes all IPv6 address configurations. More...

bool	hasIpv6Address (ipv6)
	Returns true if the specified IPv6 address is configured on the port, otherwise false. More...

Ipv6AddressConfig	getIpv6Address (ipv6)
	Returns the Ipv6AddressConfig object of the specified IPv6 address. More...

ipv6	getUnicastIpv6Address () const
	Returns a list of Ipv6AddressConfig objects associated to the port. More...

int	getUnicastIpv6Prefix ()
	Returns the port's Unicast Ipv6 Prefix. More...

vector< Ipv6AddressConfig >	getIpv6Addresses ()
	Returns a list of Ipv6AddressConfig objects associated to the port. More...

bool	isInIpv6Multicast (ipv6)
	Returns true if specified IPv6 address is a multicast address, otherwise false. More...

vector< ipv6 >	getIpv6Multicast ()
	Returns a list of IPv6 multicast addresses configured on the port. More...

void	setMtu (int)
	Sets the maximum transmission unit (MTU) value on the port. More...

int	getMtu ()
	Returns the maximum transmission unit (MTU) value configured on the port. More...

void	setIpMtu (int)
	Sets the IP maximum transmission unit (MTU) value on the port. More...

int	getIpMtu ()
	Returns the IP maximum transmission unit (MTU) value configured on the port. More...

void	setIpv6Mtu (int)
	Sets the IPv6 maximum transmission unit (MTU) value on the port. More...

int	getIpv6Mtu ()
	Returns the IPv6 maximum transmission unit (MTU) value configured on the port. More...

void	setDefaultGateway (ip)
	Sets the default gateway for this port. More...

void	setDnsServerIp (ip)
	Sets the DNS server gateway for this port. More...

void	setv6ServerIp (ipv6)
	Sets the DNS Server IPv6 gateway for this port. More...

void	setv6DefaultGateway (ipv6)
	Sets the default IPv6 gateway for this port. More...

bool	isInboundFirewallOn ()
	Returns true if the IPv4 inbound firewall is enabled, otherwise false. More...

void	setInboundFirewallService (bool)
	Enables or disables the IPv4 inbound firewall. More...

bool	isInboundIpv6FirewallOn ()
	Returns true if the IPv6 inbound firewall is enabled, otherwise false. More...

void	setInboundIpv6FirewallService (bool)
	Enables or disables the IPv6 inbound firewall. More...

Public Member Functions inherited from Port
string	getName ()
	Returns the name of the port. More...

int	getChannel ()
	Returns the channel of the port. More...

void	setChannel (int)
	Sets the channel of the port. More...

string	getTerminalTypeShortString ()
	Returns the name of the port shortened, without number. More...

string	getPortNameNumber ()
	Returns the port number. Can have something like 0/0/0, etc. More...

PortType	getType ()
	Returns the type of the port. More...

void	setDescription (string)
	Sets the description for the port. More...

string	getDescription ()
	Returns the description of the port. More...

void	setPower (bool)
	Sets the power state for the port. More...

bool	getPower ()
	Returns true if the port is on, false if the port is off. More...

void	powerChanged (bool)
	This event is emitted when the power state of the port changes. More...

bool	isStraightPins ()
	Returns true if the pins are straight, for ethernet. More...

bool	isAutoCross ()
	Returns true if the port is configured for auto crossover, for ethernet. More...

void	setBandwidth (int)
	Sets the bandwidth for the port. More...

int	getBandwidth ()
	Returns the bandwidth of the port. More...

void	setBandwidthAutoNegotiate (bool)
	Enables or disables bandwidth auto negotiation. More...

bool	isBandwidthAutoNegotiate ()
	Returns true if bandwidth auto negotiation is enabled, otherwise false. More...

void	setFullDuplex (bool)
	Enables or disables full duplex mode. More...

bool	isFullDuplex ()
	Returns true if full duplex mode is enabled, otherwise false. More...

void	setDuplexAutoNegotiate (bool)
	Enables or disables duplex auto negotiation. More...

bool	isDuplexAutoNegotiate ()
	Returns true if duplex auto negotiation is enabled, otherwise false. More...

void	setMacAddress (mac)
	Sets the MAC address on the port. More...

mac	getMacAddress ()
	Returns the MAC address set on the port. More...

void	macChanged (mac, mac)
	This event is emitted when the MAC address on the port changes. More...

mac	getBia ()
	Returns the burned-in address of the port. More...

void	setClockRate (int)
	Sets the clock rate on the port. More...

int	getClockRate ()
	Returns the clock rate on the port. More...

Link	getLink ()
	Returns the link connected to the port. More...

bool	isProtocolUp ()
	Returns true if the line protocol is up on the port, otherwise false. More...

bool	isPortUp ()
	Returns true if the status is up on the port, otherwise false. More...

Process	getEncapProcess ()
	Returns the encapsulation process. More...

Process	getKeepAliveProcess ()
	Returns the keepalive process. More...

QString	getRemotePortName ()
	Returns the name of the remote port. More...

LightStatus	getLightStatus ()
	Returns the link light status. More...

void	lightStatusChanged (LightStatus)
	This event is emitted when the link light changes. More...

void	lightBlinked ()
	This event is emitted when the link light blinks. More...

void	portStatusChanged (bool)
	This event is emitted when the port status changes. More...

void	lineProtocolChanged (bool)
	This event is emitted when the line protocol status changes. More...

void	packetReceived (string, int)
	This event is emitted when the port receives a packet. More...

void	packetSent (string, int)
	This event is emitted when the port sends a packet. More...

void	packetReceivedWithDetails (Signal, int)
	This event is emitted when the port receives a packet with details. More...

void	packetSentWithDetails (Signal, int)
	This event is emitted when the port sends a packet with details. More...

int	getHigherProcessCount ()
	Returns the higher process count. More...

HardwareQueue	getHardwareQueue ()
	Returns the hardware queue. More...

QueueProcess	getQosQueue ()
	Returns the qos queue. More...

bool	isEthernetPort ()
	Returns true if it is a ethernet port, false if not. More...

bool	isWirelessPort ()
	Returns true if it is a wireless port, false if not. More...

bool	isPowerOn ()
	Returns true if the power is on, false if not. More...

void	deleteLink ()

Public Member Functions inherited from Process
Device	getOwnerDevice ()
	Returns the device for this process. More...

Detailed Description

RouterPort handles and manipulates the router port.

Member Function Documentation

◆ addEntryEigrpPassive()

void RouterPort::addEntryEigrpPassive	(	int	,
		bool
	)

Enables or disables EIGRP passive interface for the specified AS.

Parameters

as,the	EIGRP AS number.
bPassive,true	to enable EIGRP passive interface, false to disable it.

◆ addOspfMd5Key()

bool RouterPort::addOspfMd5Key	(	short	,
		string
	)

Adds an OSPF MD5 key.

Parameters

keyId,the	key ID.
key,the	key.

Returns: bool, true if successful, otherwise false.

◆ addSummaryAddress()

bool RouterPort::addSummaryAddress	(	short	,
		ip	,
		ip	,
		int
	)

Adds a summary address for the specified EIGRP AS.

Parameters

as,the	EIGRP AS of interest.
networkAddress,the	network address.
mask,the	network mask.
adminDistance,the	administrative distance value.

Returns: bool, true if successful, otherwise false.

◆ getAclInID()

string RouterPort::getAclInID ( )

Returns the inbound ACL ID.

Parameters

string,the ID of the inbound ACL.

◆ getAclOutID()

string RouterPort::getAclOutID ( )

Returns the outbound ACL ID.

Parameters

string,the ID of the outbound ACL.

◆ getBandwidthInfo()

int RouterPort::getBandwidthInfo ( )

Returns the bandwidth.

Returns: int, the bandwidth value.

◆ getDelay()

int RouterPort::getDelay ( )

Returns the delay.

Returns: delay, the delay value.

◆ getIntOfAs()

short RouterPort::getIntOfAs ( short )

Returns the interval for the specified EIGRP AS.

Parameters

as,the EIGRP AS of interest.

Returns: short, the interval for the specified EIGRP AS.

◆ getIpsInID()

string RouterPort::getIpsInID ( )

Returns the IPS inside ID.

Returns: string, the name of the IPS.

◆ getIpsOutID()

string RouterPort::getIpsOutID ( )

Returns the ips outside ID.

Returns: string, the name of the IPS.

◆ getNatMode()

NatMode RouterPort::getNatMode ( )

Returns the NAT mode.

Parameters

enum<NatMode>,the NAT mode. NAT modes: eNatNull = 0, eNatInside = 1, eNatOutside = 2

◆ getOspfAuthKey()

string RouterPort::getOspfAuthKey ( )

Returns the OSPF authentication key.

Parameters

string,the OSPF authentication key.

◆ getOspfAuthType()

int RouterPort::getOspfAuthType ( )

Returns the OSPF authentication type.

Returns: int, the OSPF authentication type.

◆ getOspfCost()

short RouterPort::getOspfCost ( )

Returns the OSPF cost.

Returns: short, the cost value.

◆ getOspfDeadInterval()

short RouterPort::getOspfDeadInterval ( )

Returns the OSPF dead interval.

Returns: short, the OSPF dead interval value.

◆ getOspfHelloInterval()

short RouterPort::getOspfHelloInterval ( )

Returns the OSPF hello interval.

Returns: short, the OSPF hello interval value.

◆ getOspfPriority()

short RouterPort::getOspfPriority ( )

Returns the OSPF priority.

Returns: short, the OSPF priority value.

◆ getZoneMemberName()

string RouterPort::getZoneMemberName ( )

Returns the zone name in which this port belongs.

Returns: string, the zone name in which this port belongs.

◆ isCdpEnable()

bool RouterPort::isCdpEnable ( )

Returns true if CDP is enabled, otherwise false.

Returns: bool, true if CDP is enabled, otherwise false.

◆ isIkeEnabled()

bool RouterPort::isIkeEnabled ( )

Check is Ike is enabled on the port.

Returns: bool, true if it is enabled and false otherwise.

◆ isProxyArpEnabled()

bool RouterPort::isProxyArpEnabled ( )

Returns true if proxy ARP is enabled, otherwise false.

Returns: bool, true if proxy ARP is enabled, otherwise false.

◆ isRipPassive()

bool RouterPort::isRipPassive ( )

Returns true if RIP passive interface is enabled, otherwise false.

Returns: bool, true if RIP passive interface is enabled, otherwise false.

◆ isRipSplitHorizon()

bool RouterPort::isRipSplitHorizon ( )

Returns true if RIP split horizon is enabled, otherwise false.

Returns: bool, true if RIP split horizon is enabled, otherwise false.

◆ removeEntryEigrpPassive()

void RouterPort::removeEntryEigrpPassive ( int )

Remvoes EIGRP passive interface for the specified AS.

Parameters

as,the EIGRP AS number of interest.

◆ removeOspfMd5Key()

void RouterPort::removeOspfMd5Key ( short )

Removes the specified OSPF MD5 key.

Parameters

keyId,the key ID.

◆ removeSummaryAddress()

bool RouterPort::removeSummaryAddress	(	short	,
		ip	,
		ip	,
		int
	)

Removes the summary address for the specified EIGRP AS.

Parameters

as,the	EIGRP AS of interest.
networkAddress,the	network address.
mask,the	network mask.
adminDistance,the	administrative distance value.

Returns: bool, true if successful, otherwise false.

◆ resetBandwidth()

void RouterPort::resetBandwidth ( )

Resets the bandwidth.

◆ resetDelay()

void RouterPort::resetDelay ( )

Resets the delay.

◆ setAclInID()

void RouterPort::setAclInID ( string )

Sets an inbound ACL.

Parameters

aclId,the ID of the ACL.

◆ setAclOutID()

void RouterPort::setAclOutID ( string )

Sets an outbound ACL.

Parameters

aclId,the ID of the ACL.

◆ setBandwidthInfo()

void RouterPort::setBandwidthInfo ( int )

Sets the bandwidth.

Parameters

bandwidth,the bandwidth value.

◆ setCdpEnable()

void RouterPort::setCdpEnable ( bool )

Enables or disables CDP.

Parameters

bEnable,true to enable CDP, false to disable it.

◆ setDelay()

void RouterPort::setDelay ( int )

Sets the delay.

Parameters

delay,the delay value.

◆ setIkeEnabled()

void RouterPort::setIkeEnabled ( bool )

Enable or disable Ike on the port.

Parameters

flag,true to enable and false otherwise.

◆ setIntForAs()

void RouterPort::setIntForAs	(	short	,
		short
	)

Sets the interval for the specified EIGRP AS.

Parameters

as,the	EIGRP AS of interest.
interval,the	interval value.

◆ setIpsInID()

void RouterPort::setIpsInID ( string )

Sets the IPS as inside ID for this port.

Parameters

name,the name of the IPS.

◆ setIpsOutID()

void RouterPort::setIpsOutID ( string )

Sets the IPS as outside ID for this port.

Parameters

name,the name of the IPS.

◆ setNatMode()

void RouterPort::setNatMode ( NatMode )

Sets the NAT mode.

Parameters

type,the NAT mode. NAT modes: eNatNull = 0, eNatInside = 1, eNatOutside = 2

◆ setOspfAuthKey()

void RouterPort::setOspfAuthKey ( string )

Sets the OSPF authentication key.

Parameters

key,the OSPF authentication key.

◆ setOspfCost()

void RouterPort::setOspfCost ( short )

Sets the OSPF cost.

Parameters

cost,the cost value.

◆ setOspfDeadInterval()

void RouterPort::setOspfDeadInterval ( short )

Sets the OSPF dead interval.

Parameters

interval,the OSPF dead interval value.

◆ setOspfHelloInterval()

void RouterPort::setOspfHelloInterval ( short )

Sets the OSPF hello interval.

Parameters

interval,the OSPF hello interval value.

◆ setOspfPriority()

void RouterPort::setOspfPriority ( short )

Sets the OSPF priority.

Parameters

usPriority,the OSPF priority value.

◆ setProxyArpEnabled()

void RouterPort::setProxyArpEnabled ( bool )

Enables or disables proxy ARP.

Parameters

enabled,true to enable proxy ARP, false to disable it.

◆ setRipPassive()

void RouterPort::setRipPassive ( bool )

Enables or disables RIP passive interface.

Parameters

bRipPassive,true to enable RIP passive interface, false to disable it.

◆ setRipSplitHorizon()

void RouterPort::setRipSplitHorizon ( bool )

Enables or disables RIP split horizon.

Parameters

bEnable,true to enable RIP split horizon, false to disable it.

◆ setZoneMemberName()

void RouterPort::setZoneMemberName ( string )

Sets the zone name for this port.

Parameters

name,the zone name for this port.

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

CRouterPort.pki

Public Member Functions

Detailed Description

Member Function Documentation

◆ addEntryEigrpPassive()

◆ addOspfMd5Key()

◆ addSummaryAddress()

◆ getAclInID()

◆ getAclOutID()

◆ getBandwidthInfo()

◆ getDelay()

◆ getIntOfAs()

◆ getIpsInID()

◆ getIpsOutID()

◆ getNatMode()

◆ getOspfAuthKey()

◆ getOspfAuthType()

◆ getOspfCost()

◆ getOspfDeadInterval()

◆ getOspfHelloInterval()

◆ getOspfPriority()

◆ getZoneMemberName()

◆ isCdpEnable()

◆ isIkeEnabled()

◆ isProxyArpEnabled()

◆ isRipPassive()

◆ isRipSplitHorizon()

◆ removeEntryEigrpPassive()

◆ removeOspfMd5Key()

◆ removeSummaryAddress()

◆ resetBandwidth()

◆ resetDelay()

◆ setAclInID()

◆ setAclOutID()

◆ setBandwidthInfo()

◆ setCdpEnable()

◆ setDelay()

◆ setIkeEnabled()

◆ setIntForAs()

◆ setIpsInID()

◆ setIpsOutID()

◆ setNatMode()

◆ setOspfAuthKey()

◆ setOspfCost()

◆ setOspfDeadInterval()

◆ setOspfHelloInterval()

◆ setOspfPriority()

◆ setProxyArpEnabled()

◆ setRipPassive()

◆ setRipSplitHorizon()

◆ setZoneMemberName()