rtr
VirtualRouterIpAddress

VirtualRouterIpAddress represent an object for each IP address configured for a virtual router in the system. An interface on the virtual router may have more than one IP address assigned to it.



public class VirtualRouterIpAddress

Properties
addressState

type=rtr.IPv6AddressState
access=read-only
default=unknown
Displayed(tab/group)=Address State (/IPv6)

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

bcastAddrFormat

type=rtr.BcastAddrFormat
default=hostOnes
Displayed(tab/group)=Broadcast Address Format (/IPv4)

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

cgaModifier

type=string
default=00.00.00.00.00.00.00.00.00.00.00.00.00.00.00.00
minimum=47
maximum=47
Displayed(tab/group)=CGA Modifier (/IPv6)

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

customProperties This is used for any custom properties for this object.

type=Map (string to string)

domain

type=netw.DomainType
access=read-only
default=network

greTermination Indicates that GRE-MPLS packets with the destination IP specified by ipAddress can be terminated on this router interface.

type=boolean
default=false
Displayed(tab/group)=GRE-Termination (/Properties)

gwAddressType

type=rtr.InetAddressType
default=ipv4

applicable=false (Where parent is one of (ies.L3AccessInterface, rtr.MultiHomingInterface, rtr.NetworkInterface))

gwIpAddress

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Gateway IP Address (/Gateway IP Address)

applicable=false (Where parent is one of (ies.L3AccessInterface, rtr.MultiHomingInterface, rtr.NetworkInterface))

holdUpTime Specifies the time to wait for the route to accept new state of the SRRP instance which is being tracked with this address.

type=long
default=0
minimum=0
maximum=5000
units=milliseconds
Displayed(tab/group)=Hold Up Time (/Properties)

applicable=false (Where parent is one of (ies.L3AccessInterface, rtr.MultiHomingInterface, rtr.NetworkInterface, service.VideoIfAttachment))
applicable=false (Where ancestor is one of (ies.Ies, ies.Site, rtr.VirtualRouter, vprn.Site, vprn.Vprn))

ifIndex The ifIndex of the interface. Used only for 6850 nodes

type=long
access=read-only
default=0

igpInhibit

type=boolean
default=false
Displayed(tab/group)=IGP Inhibit (/Network)

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

index The only time that max=256 applies is in the case of ies.SubscriberInterface or vprn.SubscriberInterface. In all other cases the max value is limited to 16. Specifies a numerical ID value for the IP address.

type=int
access=read-create
default=0
minimum=1
maximum=256
Displayed(tab/group)=Address ID (/Properties)

ipAddrPreferred

type=boolean
access=read-create
default=false
Displayed(tab/group)=IP Address Preferred (/IPv6)

ipAddress

type=InetAddress
Displayed(tab/group)=IP Address (/Properties)

ipAddressLong

type=UInt128
access=read-only

ipAddressMax

type=UInt128
access=read-only

ipAddressMin

type=UInt128
access=read-only

ipAddressType

type=rtr.InetAddressType
default=ipv4

valid enums=ipv4 (Where parent is one of (rtr.MultiHomingInterface))

isEui64Address

type=boolean
access=read-create
default=false
Displayed(tab/group)=EUI-64 (/IPv6)

isIPv4Primary

type=boolean
access=read-only
default=true
Displayed(tab/group)=IPv4 Primary (/IPv4)

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

isManagementIpAddress

type=boolean
access=read-only
default=false

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

isSubscriberPrefix

type=boolean
access=read-create
default=false

applicable=false (Where parent is one of (ies.L3AccessInterface, rtr.MultiHomingInterface, rtr.NetworkInterface, service.VideoIfAttachment))
applicable=false (Where ancestor is one of (ies.Ies, ies.Site, vprn.Site))

isSystemIpAddress

type=boolean
access=read-only
default=false
Displayed(tab/group)=System IP (/Network)

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

operationalIpAddress

type=InetAddress
access=read-only
Displayed(tab/group)=Operational Address (/Properties)

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

prefixLength

type=int
default=24
minimum=1
maximum=128
Displayed(tab/group)=Prefix Length (/Properties)

write-access=no (Where parent is one of (rtr.MultiHomingInterface))

primaryPreference Specifies the order in which the address is used by control plane protocols and applications which require a fixed address of the interface.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Primary Preference (/IPv6)

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

primaryPreferred Specifies the IP address is selected as the interface primary preferred IP address. Only one IP address per address family will be selected as primary preferred.

type=boolean
access=read-only
Displayed(tab/group)=Primary Preferred (/IPv6)

applicable=false (Where parent is one of (rtr.MultiHomingInterface))

remoteAddressType

type=rtr.InetAddressType
default=ipv4

applicable=false (Where parent is one of (ies.L3AccessInterface, rtr.MultiHomingInterface, rtr.NetworkInterface))

remoteIpAddress

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Remote IP Address (/Remote IP Address)

applicable=false (Where parent is one of (ies.L3AccessInterface, rtr.MultiHomingInterface, rtr.NetworkInterface))

serviceId

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

serviceName

type=string
access=read-only
default=
maximum=64
Displayed(tab/group)=Service Name (/Service)

serviceType

type=service.ServiceType
access=read-only
default=unknown

subscrHostRoutePopulate

type=boolean
default=false
Displayed(tab/group)=Populate Host Routes (/Properties)

applicable=false (Where parent is one of (ies.L3AccessInterface, rtr.MultiHomingInterface, rtr.NetworkInterface, vprn.NetworkInterface))

subscriberId

type=long
access=read-only
default=1
Displayed(tab/group)=Customer ID (/Customer)

subscriberName

type=string
access=read-only
default=
maximum=255
Displayed(tab/group)=Customer Name (/Customer)

subscriberPrefixType The value of subscriberPrefixType indicates the type of subscriber prefix contained in this object.

type=rtr.SubscriberPrefixType
access=read-create
default=pd
Displayed(tab/group)=Type (/Prefix)

applicable=false (Where parent is one of (ies.L3AccessInterface, rtr.MultiHomingInterface, rtr.NetworkInterface, service.VideoIfAttachment))
applicable=false (Where ancestor is one of (ies.Ies, ies.Site, vprn.Site))

templateVersionPointer Pointer to the template if this object was created from a template.

type=Pointer
default=
Displayed(tab/group)=Associated Template (Template/Associated Template)

trackSrrpInstance Specifies the SRRP instance whose state is tracked on this ipaddress.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Track SRRP Instance (/Properties)

applicable=false (Where parent is one of (ies.L3AccessInterface, rtr.MultiHomingInterface, rtr.NetworkInterface, service.VideoIfAttachment))
applicable=false (Where ancestor is one of (ies.Ies, ies.Site, rtr.VirtualRouter, vprn.Site, vprn.Vprn))

vrfName This is used for Multi Vendor purposes

type=string
default=
minimum=0
maximum=252

  
Properties inherited from rtr.VirtualInterfaceCtp
interfaceClass, routerName, virtualRouterId, virtualRouterInterfaceId
 
Properties inherited from netw.ConnectionTerminationPoint
aggregationTagging, displayedName, isTerminatable, locale, nodeId, nodeName, numberOfConnections, terminatedObjectClassName, terminatedObjectName, terminatedObjectPointer, underlyingResourceState
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

findSitesFor

Find the sites used by the IP addresses identified by the filter.
Input Parameters:
filter : FilterHolder -
expandChildren : boolean -
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:
infoList : List (generic.CommonManagedEntityInformation) -
Methods inherited from rtr.IpAddressLikeCtp
find
 
Methods inherited from netw.ConnectionTerminationPoint
findAvailableAccessCtpsPerNode, findAvailableCtpsPerNode, findAvailableNetworkCtpsPerNode, findCtp, findCtpFiltered, findCtpsOnDirectlyTerminatablePort, findCtpsOnMultiplePorts, findCtpsOnMultiplePortsWithFilter
 
Supported Network Elements
7450 ESS
7210 SAS M
7210 SAS X
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS R
7250 IXR
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
7701 CPAA
OS6850/6850E
OS6855
OS6400
Generic NE 1.0.0
OS6250
OS6450
OS6350
OS9700E/9800E
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6360
OS6465
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Wavence SM
Product Specifics
7210 SAS D (all versions)
7210 SAS D 20.0.0
7210 SAS D 21.0.0
7210 SAS D 22.0.0
7210 SAS D 23.0.0
7210 SAS D 24.0.0
7210 SAS D 25.0.0
7210 SAS Dxp (all versions)
7210 SAS Dxp 20.0
7210 SAS Dxp 21.0
7210 SAS Dxp 22.0
7210 SAS Dxp 23.0
7210 SAS Dxp 24.0
7210 SAS Dxp 25.0
7210 SAS E (all versions)
7210 SAS K (all versions)
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M (all versions)
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp (all versions)
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R (all versions)
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7210 SAS S/Sx (all versions)
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T (all versions)
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7210 SAS X (all versions)
7250 IXR (all versions)
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS (all versions)
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7701 CPAA 8.0
7705 SAR Gen 2 (all versions)
7705 SAR Gen 2 25.0
7705 SAR H (all versions)
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR Hm (all versions)
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR (all versions)
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR (all versions)
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS (all versions)
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 5.0
DC VSA8 6.0
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0
Generic NE (all versions)
Generic NE 1.0.0
OS6250 6.6.3
OS6250 6.6.4
OS6250 6.6.5
OS6250 6.7.1
OS6350 6.7.2
OS6360 8.10
OS6360 8.10
OS6360 8.9
OS6360 8.9
OS6400 6.4.3
OS6400 6.4.4
OS6400 6.4.5
OS6450 6.6.4
OS6450 6.6.5
OS6450 6.7.1
OS6450 6.7.2
OS6465 8.10
OS6465 8.10
OS6465 8.6
OS6465 8.7
OS6465 8.8
OS6465 8.8
OS6465 8.9
OS6465 8.9
OS6465 8.9
OS6560/OS6560E 8.10
OS6560/OS6560E 8.10
OS6560/OS6560E 8.6
OS6560/OS6560E 8.7
OS6560/OS6560E 8.8
OS6560/OS6560E 8.8
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6570M 8.10
OS6570M 8.10
OS6570M 8.9
OS6850/6850E 6.4.2
OS6850/6850E 6.4.3
OS6850/6850E 6.4.4
OS6850/6850E 6.4.5
OS6850/6850E 6.4.6
OS6855 6.4.4
OS6855 6.4.5
OS6855 6.4.6
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.6
OS6860E/OS6860N 8.7
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6865 8.10
OS6865 8.10
OS6865 8.6
OS6865 8.7
OS6865 8.8
OS6865 8.8
OS6865 8.9
OS6865 8.9
OS6865 8.9
OS6870 8.10
OS6900 8.10
OS6900 8.10
OS6900 8.6
OS6900 8.7
OS6900 8.8
OS6900 8.8
OS6900 8.9
OS6900 8.9
OS6900 8.9
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6
Wavence SM (all versions)
Wavence SM 19A.0.0
Wavence SM 20A.0.0
Wavence SM 21A.0.0
Wavence SM 22.0.0
Wavence SM 22A.0.0
Wavence SM 23.0.0
Wavence SM 23A.0.0
Wavence SM 24.0.0
Wavence SM 25.0.0