topologysim
IgpLink

Represents a simulated IGP link between two routers, between a router and a subnet, or between a subnet and a router.



public abstract class IgpLink

Properties
adminGroups The Administrative Group contains a bit mask. Each set bit corresponds to one administrative group assigned to the interface. A link may belong to multiple groups.

By convention, the least significant bit is referred to as 'group 0', and the most significant bit is referred to as 'group 31'.

The Administrative Group is also called Resource Class/Color.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Administrative Groups (Traffic Engineering)

ifIndex For an unnumbered IGP link, this field represents the interface index. Note that this parameter is not configured directly but is derived from ipAddress.

type=int
access=read-only
Displayed(tab/group)=I/F Index

ipAddress The local IP address of the IGP link. For unnumbered IGP links, the IP address is of the form 0.d.d.d.

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=IP Address

ipAddressType

type=rtr.InetAddressType
access=read-create
default=ipv4

linkBandwidth

type=long
default=0
minimum=0
units=kbps
Displayed(tab/group)=Link Bandwidth

linkGenetics Specifies if the link is an original or a duplicate (clone).

type=topology.LinkGenetics
access=read-create
Mandatory on create
Displayed(tab/group)=Link Genetics (/Hidden)

linkSourcePointer A pointer to the object (router or subnet) from which this link starts.

type=Pointer
access=read-only
Displayed(tab/group)=Link Source

linkTerminationPointer A pointer to the object (router or subnet) on which this link terminates.

type=Pointer
access=read-create
Mandatory on create
Displayed(tab/group)=Link Termination

linkType Represents the type of link (transit, point-to-point, etc).

type=topology.LinkType
access=read-create
Mandatory on create
Displayed(tab/group)=Link Type

maskLen The mask length of the subnet connected to the IGP link.

type=int
default=24
minimum=1
maximum=32
Displayed(tab/group)=Mask Length

maxBandwidth The Maximum Bandwidth specifies the maximum bandwidth that can be used on this link, in this direction (from the router originating the LSA to its neighbor). This is the true link capacity.

type=float
minimum=0
maximum=1000000000000000000
units=kbps
Displayed(tab/group)=Maximum Bandwidth (Traffic Engineering)

maxReservableBandwidth The Maximum Reservable Bandwidth specifies the maximum bandwidth that may be reserved on this link, in this direction (from the router originating the LSA to its neighbor). Note that this may be greater than the maximum bandwidth (in which case the link may be oversubscribed).

type=float
minimum=0
maximum=1000000000000000000
units=kbps
Displayed(tab/group)=Maximum Reservable Bandwidth (Traffic Engineering)

metric The protocol specific cost of the link.

type=int
default=1000
minimum=0
maximum=65535
Displayed(tab/group)=Metric

neighbor The remote neighbor of this IGP link. The format of the string depends on the specific subclass of IGP link. The neighbor is initialized from the linkTerminationPointer.

type=string
access=read-only
maximum=252

oppositeLinkPointer A pointer to the link in the opposite direction.

For P2P, this is the pointer of the link, if any, from the linkTermination router and this one.

For transit networks, this is the pointer of the fake opposite link from subnet to router (for original links) or from router to subnet (for duplicate links).

type=Pointer
access=read-only
Displayed(tab/group)=Opposite Link

protocol The protocol that the link was learned from.

type=topologysim.IgpProtocol
access=read-only
Displayed(tab/group)=Protocol

routerId The numeric form of the originating router ID.

type=int
access=read-only

routerIdStr The IP Address form of the originating router ID.

type=string
access=read-only
maximum=50
Displayed(tab/group)=Advertising Router ID

teMetric The Traffic Engineering Metric specifies the link metric for traffic engineering purposes. This metric may be different than the standard link metric. Typically, this metric is assigned by a network administrator.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=TE Metric (Traffic Engineering)

topologysim.RsvpLink-Set type=Children-Set
trafficEngineering Used to indicate that traffic engineering parameters were learned from the protocol.

type=boolean
default=false
Displayed(tab/group)=Traffic Engineering

unnumbered Set when the interface is unnumbered.

type=boolean
access=read-create
default=false
Displayed(tab/group)=Unnumbered Interface

unreservedBandwidthP0 The Unreserved Bandwidth specifies the amount of bandwidth not yet reserved at priority 0. The value should be less than or equal to the Maximum Reservable Bandwidth.

type=float
access=read-only
units=kbps
Displayed(tab/group)=Unreserved Bandwidth (Priority 0) (Traffic Engineering/Unreserved Bandwidth)

unreservedBandwidthP1 The Unreserved Bandwidth specifies the amount of bandwidth not yet reserved at priority 1. The value should be less than or equal to the Maximum Reservable Bandwidth.

type=float
access=read-only
units=kbps
Displayed(tab/group)=Unreserved Bandwidth (Priority 1) (Traffic Engineering/Unreserved Bandwidth)

unreservedBandwidthP2 The Unreserved Bandwidth specifies the amount of bandwidth not yet reserved at priority 2. The value should be less than or equal to the Maximum Reservable Bandwidth.

type=float
access=read-only
units=kbps
Displayed(tab/group)=Unreserved Bandwidth (Priority 2) (Traffic Engineering/Unreserved Bandwidth)

unreservedBandwidthP3 The Unreserved Bandwidth specifies the amount of bandwidth not yet reserved at priority 3. The value should be less than or equal to the Maximum Reservable Bandwidth.

type=float
access=read-only
units=kbps
Displayed(tab/group)=Unreserved Bandwidth (Priority 3) (Traffic Engineering/Unreserved Bandwidth)

unreservedBandwidthP4 The Unreserved Bandwidth specifies the amount of bandwidth not yet reserved at priority 4. The value should be less than or equal to the Maximum Reservable Bandwidth.

type=float
access=read-only
units=kbps
Displayed(tab/group)=Unreserved Bandwidth (Priority 4) (Traffic Engineering/Unreserved Bandwidth)

unreservedBandwidthP5 The Unreserved Bandwidth specifies the amount of bandwidth not yet reserved at priority 5. The value should be less than or equal to the Maximum Reservable Bandwidth.

type=float
access=read-only
units=kbps
Displayed(tab/group)=Unreserved Bandwidth (Priority 5) (Traffic Engineering/Unreserved Bandwidth)

unreservedBandwidthP6 The Unreserved Bandwidth specifies the amount of bandwidth not yet reserved at priority 6. The value should be less than or equal to the Maximum Reservable Bandwidth.

type=float
access=read-only
units=kbps
Displayed(tab/group)=Unreserved Bandwidth (Priority 6) (Traffic Engineering/Unreserved Bandwidth)

unreservedBandwidthP7 The Unreserved Bandwidth specifies the amount of bandwidth not yet reserved at priority 7. The value should be less than or equal to the Maximum Reservable Bandwidth.

type=float
access=read-only
units=kbps
Displayed(tab/group)=Unreserved Bandwidth (Priority 7) (Traffic Engineering/Unreserved Bandwidth)

utilization The utilization level of the link shown as a percentage between 0 and 100.

type=float
access=read-only
default=0
minimum=0
units=%
Displayed(tab/group)=Utilization

  
Properties inherited from simulator.Element
administrativeState, description, displayedName, modelPointer, modelType, operationalState, scenarioId, scenarioName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed