topology
Router

Represents a router learned from one of the routing protocols.



public class Router

Properties
areaPointers Set of area FDNs that to which this router belongs.

type=Set (Pointer)
access=read-only

chassisType The Network Element Chassis Type.

type=equipment.ShelfType
default=unknownShelf

checkpointDetail Specific details copied topology.Checkpoint to help further identify the checkpoint. For example, for an OSPF checkpoint, this would contain the area ID.

This field is only meaningful if isCheckpointObject is true.

type=string
access=read-only
default=
minimum=0
maximum=32
Displayed(tab/group)=Checkpoint Detail (Checkpoint Details/Checkpoint)

checkpointId The ID of the checkpoint (topology.Checkpoint or its subclasses).

This field is only meaningful if isCheckpointObject is true.

type=long
access=read-only
default=0
Displayed(tab/group)=Checkpoint ID (Checkpoint Details/Checkpoint)

checkpointProtocol The protocol of the checkpoint (topology.Checkpoint or its subclasses).

This field is only meaningful if isCheckpointObject is true.

type=topology.Protocol
access=read-only
Displayed(tab/group)=Checkpoint Protocol (Checkpoint Details/Checkpoint)

checkpointTime The time that this checkpoint object was created.

This field is only meaningful if isCheckpointObject is true.

type=Date
access=read-only
Displayed(tab/group)=Checkpoint Time (Checkpoint Details/Checkpoint)

cpamName The Managed Node OR Protocol Name OR Third Party/GNE name.

type=string
access=read-only
minimum=0
maximum=255
Displayed(tab/group)=CPAM Name

description The description (user configurable).

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description

displayedName The displayed name.

type=string
minimum=0
maximum=32
Displayed(tab/group)=Name

dynamicHostname The Dynamic Hostname published by the IGP protocol (currently applicable for ISIS only)

type=string
access=read-only
minimum=0
maximum=255
Displayed(tab/group)=Dynamic Hostname

id The numerical form of the router ID.

type=int
access=read-create
Mandatory on create

igmpIntfPointers The set of IGMP interface pointers which are configured in this router.

type=Set (Pointer)
access=read-only

igmpPointer If the router is managed by NFM-P and is IGMP enabled, this property specifies the FDN of the igmp.Site.

type=Pointer
access=read-only
default=
Displayed(tab/group)=IGMP (Multicast/Multicast)

isCheckpointObject Represents that this instance of the router object is in fact contained in a checkpoint.

The real topology object always has a value of "false" for isCheckpointObject.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Is Checkpoint Object (/Checkpoint)

isCpaa This flag is set if this router is a CPAA.

type=boolean
access=read-only
Displayed(tab/group)=CPAA

isReference Specifies which protocols have been referenced on this object.

type=topology.CheckPoint
access=read-only
Displayed(tab/group)=Has Reference (Reference)

isisAttached Specifies if this ISIS router has the ATT flag set.

type=boolean
access=read-only
default=false
Displayed(tab/group)=ISIS Attached

isisIpVersion The supported IP version for ISIS.

type=topology.AddressType
access=read-only
default=ipv4
Displayed(tab/group)=ISIS Supported IP Version

isisIpv6Attached Specifies if this ISIS router has the ATT flag set for IPV6.

type=boolean
access=read-only
default=false
Displayed(tab/group)=ISIS IPV6 Attached (/ISIS IPV6)

isisIpv6Type The supported IP V6 type for ISIS, either native or multi-topology.

type=topology.IsisIpv6Type
access=read-only
default=none
Displayed(tab/group)=ISIS IPV6 Type (/ISIS IPV6)

isisOverload Specifies if this ISIS router is overloaded.

type=boolean
access=read-only
default=false
Displayed(tab/group)=ISIS Overload

isisReferenceTime The time the last ISIS reference was created

type=Date
access=read-only
Displayed(tab/group)=ISIS Reference Time (Reference)

isisRole The role that this router plays in the ISIS network.

type=topology.IsisRole
access=read-only
Displayed(tab/group)=ISIS Role

isisSystemId The intermediate system identifier for the router in the ISIS network, if applicable.

type=string
access=read-only
maximum=16
Displayed(tab/group)=ISIS System ID

lastChangeTime The last time Router was changed.

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Change Time

level1CpaaInstanceId The CPAA ISIS Instance ID for the Level1 routing domain of of this router

type=int
access=read-only
default=0
minimum=0
maximum=31
Displayed(tab/group)=CPAA ISIS Instance ID (/Level 1)

licenseConsumed The value specifies the number of license points consumed.

type=double
access=read-only
default=0.0
Displayed(tab/group)=License Points Consumed (/Licensed product and consumed)

licenseType The license type that this router plays(Big,Small,Third) in network.

type=topology.LicenseType
access=read-only
default=third
Displayed(tab/group)=License Type

licensedProduct The value specifies the license product.

type=string
access=read-only
default=None
maximum=252
Displayed(tab/group)=Licensed Product (/Licensed product and consumed)

managedNePointer If the router is one managed by NFM-P, this property specifies the FDN of the netw.NetworkElement.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Network Element

nonRoutedReferenceTime The time the last Non-Routed reference was created

type=Date
access=read-only
Displayed(tab/group)=Non-Routed Reference Time (Reference)

nredRouterType The router type in the context of Non-Routed Edge Discovery Policy

type=topology.NREDRouterType
access=read-only
default=none

ospfReferenceTime The time the last OSPF reference was created

type=Date
access=read-only
Displayed(tab/group)=OSPF Reference Time (Reference)

ospfRole The role that this router plays in the OSPF network.

type=topology.OspfRole
access=read-only
Displayed(tab/group)=OSPF Role

ospfv3ReferenceTime The time the last OSPFv3 reference was created

type=Date
access=read-only
Displayed(tab/group)=OSPFv3 Reference Time (Reference)

ospfv3Role The role that this router plays in the OSPFv3 network.

type=topology.OspfRole
access=read-only
Displayed(tab/group)=OSPFv3 Role

pimDomainPointer Points to PIM Domain.

type=Pointer
access=read-only
default=

pimPointer If the router is managed by NFM-P and is PIM enabled, this property specifies the FDN of the pim.Site.

type=Pointer
access=read-only
default=
Displayed(tab/group)=PIM (Multicast/Multicast)

routerId The IP address form of the router ID.

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=Router ID

routerIdAddrType

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

topology.AreaCheckPoint-Set type=Children-Set
topology.AreaReference-Set type=Children-Set
topology.IsisLink-Set type=Children-Set
topology.NonRoutedLink-Set type=Children-Set
topology.OspfLink-Set type=Children-Set
  
Properties inherited from topology.ASContainedObject
asName, asNumber
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

findAllCheckpoints

Find all the checkpoints that exist for this checkpointable object.
Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
checkpoints : List (generic.CommonManagedEntityInformation) -