| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| administrativeState |
type=netw.AdministrativeState default=tmnxInService Displayed(tab/group)=Administrative State (/Other) |
| aggregatorId |
aggregator ID that this static route goes from/to
type=string access=read-only default= maximum=50 Displayed(tab/group)=Aggregator ID |
| backupNextHopAddress |
Specifies the ip address of the backup next-hop for the static route.
type=InetAddress default=0.0.0.0 Displayed(tab/group)=Backup Next Hop (/Other) |
| backupNextHopAddressType |
The address type of backupNextHopAddress.
type=rtr.InetAddressType default=ipv4 |
| backupNextHopStatus |
The value of this property indicates whether
backupNextHopAddress is in use or not.
If backupNextHopAddress is not in use, the
backupNextHopStatus is 'inactive'. If
backupNextHopAddress is in use as a backup to the primary
hop represented by targetIpAddressWithZoneIndex,
backupNextHopStatus is 'activeAsBackup'. If
backupNextHopAddress is in use as the primary hop,
backupNextHopStatus is 'activeAsPrimary'.
type=int access=read-only Displayed(tab/group)=Backup Next Hop Status (/Other) enums= 1: inactive - Inactive 2: activeAsBackup - Active As Backup 3: activeAsPrimary - Active As Primary |
| bfdEnabled |
specifies whether Bi-directional Forwarding Detection is enabled in this
interface. When the value is 'true', this interface can establish BFD sessions
and use BFD as a signalling mechanism. When it is 'false', it cannot
use BFD.
type=boolean default=false Displayed(tab/group)=BFD Enabled |
| bfdOperationalState |
operational state of the BFD session
type=int access=read-only default=0 Displayed(tab/group)=BFD Operational State (/Other) enums= 0: unspecified - N/A 1: unknown - Unknown 2: inService - In Service 3: outOfService - Out Of Service 4: transition - Transition |
| bfdState |
state of the BFD session
type=rtr.BfdSessionState access=read-only default=-1 Displayed(tab/group)=BFD State (/Other) |
| community |
The Community parameter specifies a route policy community ID for the static or aggregated route.
A route policy uses the community value to control the distribution of the route into other protocols.
BGP uses the community value to control the distribution of this route into other routers. Only one community can
be associated with an aggregate or static route. The parameter is defined as an ID string or a well-known standard community.
The format for an ID string is [2-byte-AS-number]:[2-byte-decimal-number]. For example, 100:30 is a valid ID string.
The permitted well-known standard communities are no-export, no-export-subconfed, no-advertise, and null.
type=string minimum=0 maximum=72 Displayed(tab/group)=Community |
| cpeAddrType |
The address type of CpeAddress.
type=rtr.InetAddressType default=unknown |
| cpeAddress |
The IP address of the target CPE device. When this object is
configured, ICMP pings will be sent to this target IP address
to determine CPE connectivity and whether this static route
should be active.
type=InetAddress default= Displayed(tab/group)=Target IP Address (/CPE Check) |
| cpeDropCount |
The number of consecutive ping-replies that must be missed
before concluding the CPE is down. If the CPE is determined
to be down, the associated static route will be deactivated.
type=int default=3 minimum=1 maximum=255 Displayed(tab/group)=Drop Count (/CPE Check) |
| cpeEnableLog |
It specifies whether to enable the logging of transitions
between active and in-active based on the CPE connectivity check.
type=boolean default=false Displayed(tab/group)=Log (/CPE Check) |
| cpeInterval |
The interval, in seconds, between ICMP pings to the target
CPE IP address.
type=int default=1 minimum=1 maximum=255 units=seconds Displayed(tab/group)=Interval (/CPE Check) |
| 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) |
| description |
type=string default= minimum=0 maximum=80 Displayed(tab/group)=Description |
| destIpMax |
type=UInt128 access=read-only |
| destIpMin |
type=UInt128 access=read-only |
| destination |
type=InetAddress access=read-create Mandatory on create Displayed(tab/group)=Destination (/Destination) |
| destinationAddressType |
type=rtr.InetAddressType access=read-create default=ipv4 |
| destinationClass |
The value of destination class specifies the destination-class
for this static route. The value of 0 means no destination-class.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Destination Class Index (/Source/Destination Class Index) |
| disallowIGP |
type=generic.TruthValue default=false Displayed(tab/group)=Disallow IGP (/IGP Shortcut) |
| edgeId |
edge ID that this static route goes from/to
type=string access=read-only default= maximum=50 Displayed(tab/group)=Edge ID |
| enableDynamicBgp |
The Dynamic BGP parameter specifies whether dynamic BGP route selection is enabled.
When the parameter is enabled, the black hole static route dynamically derives
its next hop from the best BGP route with the same IP prefix.
type=boolean default=false Displayed(tab/group)=Dynamic BGP (/Destination) applicable=false (Where parent is one of (vprn.Site)) |
| enableLdpSyncTimer |
If the value of enableLdpSyncTimer is true, this static
route will not enable the preferred route immediately after the
interface to the next-hop comes up but will wait for the LDP
adjacency on the link to come up and start the ldp sync timer.
On timer expiration, routing will enable the static route.
type=boolean default=false Displayed(tab/group)=Enable LDP Sync Timer applicable=false (Where parent is one of (vprn.Site)) |
| fcName |
The forwarding class associated to the static route.
type=rtr.FcEnum default=none Displayed(tab/group)=Forwarding Class Name |
| fcPriority |
The Priority assigned to the static route
type=int default=undefined Displayed(tab/group)=Forwarding Class Priority enums= 0: undefined - Undefined 1: low - Low 2: high - High |
| flexibleAlgorithmId |
Specifies the Flexible Algorithm ID to use when resolving over
the Segment Routing tunnels.
Only tunnels that match this ID will be used to resolve the tunnel
destination.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Flexible Algorithm ID (/IGP Shortcut) |
| generateIcmp |
type=boolean default=false Displayed(tab/group)=Generate ICMP (/Destination) |
| id |
type=long access=read-create default=0 minimum=1 maximum=2147483647 Displayed(tab/group)=Static Route ID |
| igpShortcut |
This attribute is deprecated for 7750/7450/7950 13.0 and above nodes.
It has been replaced by indirectTunnelLdp and indirectTunnelRsvpTe.
DEPRECATED: 13.0.R1 type=rtr.IgpShortcut default=unused Displayed(tab/group)=IGP Shortcut (/IGP Shortcut) |
| indirectResStatus |
This specifies specifies the resolution status of this entry
type=bgp.ResolveStatus default=disabled Displayed(tab/group)=Resolution Status (/IGP Shortcut) |
| indirectTunnelLdp |
This specifies if LDP Route Forwarding Equivalence Class (FEC) tunneling mechanism will be used to
resolve next-hop for the static-route or not
type=generic.TruthValue default=false Displayed(tab/group)=LDP (/IGP Shortcut) |
| indirectTunnelMplsFwdPolicy |
Specifies whether MPLS Forward Policy is enabled on this static route.
type=generic.TruthValue default=false Displayed(tab/group)=MPLS Forward Policy (/IGP Shortcut) |
| indirectTunnelRibApi |
Specifies whether MPLS RIB API is enabled on this static route.
type=generic.TruthValue default=false Displayed(tab/group)=RIB-API (/IGP Shortcut) |
| indirectTunnelRsvpTe |
This specifies if RSVP Traffic Engineering tunneling mechanism will be used to resolve next-hop
for the static-route or not
type=generic.TruthValue default=false Displayed(tab/group)=RSVP-TE (/IGP Shortcut) |
| indirectTunnelSrIsis |
This specifies if SR ISIS tunneling mechanism will be used to
resolve next-hop for the static-route or not
type=generic.TruthValue default=false Displayed(tab/group)=SR-ISIS (/IGP Shortcut) |
| indirectTunnelSrOspf |
This specifies if SR OSPF tunneling mechanism will be used to
resolve next-hop for the static-route or not
type=generic.TruthValue default=false Displayed(tab/group)=SR-OSPF (/IGP Shortcut) |
| indirectTunnelSrOspf3 |
Specifies if SR OSPFv3 tunneling mechanism will be used to resolve next-hop for the static
route or not.
type=generic.TruthValue default=false Displayed(tab/group)=SR-OSPFv3 (/IGP Shortcut) |
| indirectTunnelSrTe |
This specifies if SR Traffic Engineering tunneling mechanism will be used to resolve next-hop
for the static-route or not
type=generic.TruthValue default=false Displayed(tab/group)=SR-TE (/IGP Shortcut) |
| interfaceId |
type=long access=read-only default=0 |
| interfaceName |
type=string access=read-only default= maximum=252 Displayed(tab/group)=Interface (/Destination) |
| interfacePointer |
type=string default= maximum=252 |
| loadBalWeight |
Specifies the load balancing weight for all of the ECMP next-hops.
The value of 0 means no load balancing weight.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Load Balancing Weight (/Other) |
| metric |
type=int default=1 minimum=0 maximum=65535 Displayed(tab/group)=Metric (/Other) |
| multicastCapablePeers |
type=boolean access=read-create default=false Displayed(tab/group)=Multicast Capable Peers (/Destination) |
| nextHop |
type=long |
| nextHopType |
type=int default=ipAddress Displayed(tab/group)=Next Hop Type (/Destination) enums= 0: unknown - Unknown (not selectable) 1: ipAddress - IP address 2: netIf - NETIF 3: osc - OSC 4: oscSfp - OSCSFP 5: ipv4Address - IPv4 address 6: ipv6Address - IPv6 address |
| nextHopValue |
type=string default= Displayed(tab/group)=Next Hop (/Destination) |
| operationalState |
type=int access=read-only default=inactive Displayed(tab/group)=Operational State (/Other) enums= 1: active - Up 2: inactive - Down |
| paddingSize |
specifies the padding size for the ICMP ping test packet.
vRtrInetStaticRoutePaddingSize is valid if the value of
vRtrInetStaticRouteCpeAddr is non-empty. This option only
applies to IPv4 static routes."
type=int default=56 minimum=0 maximum=16384 Displayed(tab/group)=Packet Size (/CPE Check) |
| preference |
type=int default=5 minimum=1 maximum=255 Displayed(tab/group)=Preference (/Other) |
| prefixLength |
type=int access=read-create default=24 minimum=0 maximum=128 Displayed(tab/group)=Prefix Length (/Destination) |
| prefixListFlag |
Whether to match any, all or none of the entries in the prefix list.
type=rtr.PrefixListFlag default=any Displayed(tab/group)=Prefix List Flag (/Prefix List) |
| prefixListName |
The Prefix List name for conditional routes.
type=string default= minimum=0 maximum=32 Displayed(tab/group)=Prefix List Name (/Prefix List) |
| redistribute |
IP static route with redistribution (true/false)
type=boolean access=read-create default=false Displayed(tab/group)=Redistribute (/Other) |
| routingInstance |
type=long access=read-only default=0 Displayed(tab/group)=Routing Instance ID (/Routing Instance) |
| routingInstanceName |
type=string access=read-only default= maximum=252 Displayed(tab/group)=Routing Instance Name (/Routing Instance) |
| rtr.LspEntry-Set |
type=Children-Set |
| serviceId |
type=long access=read-only default=0 |
| serviceType |
type=service.ServiceType access=read-only default=unknown |
| siteId |
type=string access=read-only default= maximum=50 Displayed(tab/group)=Site ID (/Site) |
| siteName |
type=string access=read-only default= maximum=252 Displayed(tab/group)=Site Name (/Site) |
| snmpId |
The SNMP mib index id on the applicable nodes.
type=long access=read-only default=0 Displayed(tab/group)=ID on the Node |
| sourceClass |
The value of source class specifies the source-class for
this static route. The value of 0 means no source-class.
type=int default=0 minimum=0 maximum=255 Displayed(tab/group)=Source Class Index (/Source/Destination Class Index) |
| staticRouteTag |
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Tag (/Other) |
| subscriberId |
type=long access=read-only default=0 |
| targetIpAddress |
type=InetAddress access=read-create default=0.0.0.0 Displayed(tab/group)=IP Address (/Destination) |
| targetIpAddressLong |
type=UInt128 access=read-only |
| targetIpAddressType |
type=rtr.InetAddressType access=read-create default=ipv4 |
| targetIpAddressWithZoneIndex |
Identical to targetIpAddress unless targetIpAddressType is ipv6z.
Represents the address with the zone index when ipv6z.
type=InetAddress access=read-only default=0.0.0.0 |
| targetIpAddressZoneIndexPointer |
Meaningful only for ipv6z addresses.
type=string access=read-create default= maximum=252 Mandatory on create Displayed(tab/group)=Zone Index (/Destination) |
| templateVersionPointer |
Pointer to the template if this object was created from a template.
type=Pointer default= Displayed(tab/group)=Associated Template (Template/Associated Template) |
| tunnelName |
type=string access=read-only default= maximum=252 Displayed(tab/group)=IPSec Tunnel (/Destination) |
| tunnelPointer |
The value of tunnelPointer specifies the name of the IPsec tunnel to be used for the next-hop of this static
route and it depends on the value of "type" to be set to "nextHop".
type=Pointer default= |
| type |
type=int access=read-create default=nextHop Displayed(tab/group)=Type (/Destination) enums= 0: unknown - Unknown (not selectable) 1: nextHop - Next Hop 2: indirect - Indirect 3: blackHole - Black Hole 4: grt - Global Route Table 135: rfDir - RF Dir (not selectable) |
| validateNexthop |
The validate Next-hop specifies whether or not to track the state of the next-hop in
the IPV4 ARP Cache or the IPv6 Neighbor Cache. When validateNexthop is
set to 'true', the next-hop is checked for reachability in the IPV4 ARP Cache or the
IPV6 Neighbor Cache. The object is only supported for directly connected next-hops.
type=boolean default=false Displayed(tab/group)=Validate Next Hop (/Destination) |
| vrfName |
This is used for Multi Vendor purposes
type=string default= minimum=0 maximum=252 |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
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
infoList
: List (generic.CommonManagedEntityInformation) -
deployer
: Deployer - the deployment state
synchronousDeploy
: boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure
: boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries
: int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval
: long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription
: string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName
: string - the full name of the object.
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
rtr.StaticRoute.removeException
aInSiteFdn
: string -
aInSvcFdn
: string -
aInTag
: string -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
result
: string -