| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| adjState |
type=int access=read-only default=unknown Displayed(tab/group)=Adjacency State (Protocol Properties) enums= 1: unknown - Unknown 2: down - Down 3: attempt - Attempt 4: init - Init 5: 2way - 2Way 6: exstart - Exstart 7: exchange - Exchange 8: loading - Loading 9: full - Full |
| adjacencySidType |
Specifies whether the adjacencySidValue is not valid, an index value or an absolute label value.
type=int default=0 Displayed(tab/group)=SID Type (Segment Routing/Adjacency SID) enums= 0: none - None 2: label - Label |
| adjacencySidValue |
This value along with sidType specifies the SID value or index for this adjacency set SID.
The value of this property should be within the range specified by the OSPF Site
srlbReservedLabelBlock range.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=SID Value (Segment Routing/Adjacency SID) |
| advertiseSubnet |
type=boolean default=true Displayed(tab/group)=Advertise Subnet (Protocol Properties) |
| areaId |
type=string access=read-only default=0.0.0.0 maximum=50 Displayed(tab/group)=Area ID (/Routing Instance) |
| authKeychain |
type=Pointer default= Displayed(tab/group)=Authentication Keychain (Authentication) |
| authenticationKey |
type=string default= minimum=0 maximum=8 Displayed(tab/group)=Password (Authentication) |
| authenticationType |
type=ospf.AuthenticationType default=none Displayed(tab/group)=Authentication Type (Authentication) |
| backupDesignatedRouterAddress |
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Backup Designated Router IP Address (/Designated Router) |
| backupDesignatedRouterAddressType |
type=rtr.InetAddressType access=read-only default=ipv4 |
| backupDesignatedRouterId |
type=string access=read-only default=0.0.0.0 maximum=50 Displayed(tab/group)=Backup Designated Router ID (/Designated Router) |
| bfdDRsOnly |
"Enables/Disables Drs Only option for a BFD interface" Applicable to AOS nodes
type=int default=allNbrs Displayed(tab/group)=BFD DRs-Only (Protocol Properties) enums= 1: drsOnly - DRs-Only 2: allNbrs - All-Neighbors |
| 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 (Protocol Properties) |
| bfdStrict |
The value of bfdStrict specifies whether BFD strict-mode is enabled for this OSPF interface.
When the value is 'true', the router will begin advertising the B-flag using Link-Local-Signalling (LLS).
The value of this object is ignored when the object enableBfdStrict is 'false'
type=boolean default=false Displayed(tab/group)=BFD Strict (Protocol Properties) |
| bfdStrictHoldDown |
The value of bfdStrictHoldDown specifies the hold down time to delay the OSPF adjacency bring up following
BFD session establishment.
The value '0' results in immediate establishment of OSPF adjacency when the BFD session state is UP.
type=int default=0 minimum=0 maximum=600 Displayed(tab/group)=Strict Mode Hold Down (Protocol Properties) |
| creationOrigin |
type=svt.L2RouteOriginType access=read-create default=manual |
| customProperties |
This is used for any custom properties for this objects.
type=Map (string to string) |
| designatedRouterAddress |
type=InetAddress access=read-only default=0.0.0.0 Displayed(tab/group)=Designated Router IP Address (/Designated Router) |
| designatedRouterAddressType |
type=rtr.InetAddressType access=read-only default=ipv4 |
| designatedRouterId |
type=string access=read-only default=0.0.0.0 maximum=50 Displayed(tab/group)=Designated Router ID (/Designated Router) |
| hasProblem |
type=boolean access=read-only default=false Displayed(tab/group)=RCA Audit Problem(s) (/RCA) |
| helloInterval |
type=int default=10 minimum=1 maximum=65535 units=seconds Displayed(tab/group)=Hello Interval (Protocol Properties/Intervals) |
| instanceIndex |
Identifies a specific instance of a version of the OSPF protocol running
in the router instance specified by the routerId.
type=long access=read-only default=0 Displayed(tab/group)=Instance ID (/Routing Instance) |
| interfaceInstanceIndex |
type=long access=read-only default=0 |
| ipsecstaticSAName |
type=ospf.IPsecStaticSAAuthType default=none Displayed(tab/group)=IPsec Security Association Name (IPsec Static SA) |
| isPassive |
type=boolean default=false Displayed(tab/group)=Passive (Protocol Properties) |
| lastAuditTime |
Time of last running the RCA Audit of this object.
type=Date access=read-only Displayed(tab/group)=Last Audit Time (/RCA) |
| lastEventTime |
type=Date access=read-only default=0 |
| ldpSyncState |
Indicates if IGP-LDP synchronization is enabled on this interface.
type=int access=read-only Displayed(tab/group)=LDP Synchronization State (Protocol Properties/LDP Synchronization) enums= 1: tmnxUnknown - Unknown 2: tmnxInService - Up 3: tmnxOutOfService - Down 4: tmnxTransition - Transition |
| loadBalancingWeight |
Specifies an explicit load-balancing-weight for this interface.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Load Balancing Weight (Protocol Properties) |
| loopfreeAlternateExclude |
The value of loopfreeAlternateExclude specifies whether or not the OSPF interface should be
excluded during LFA calculations.
type=boolean default=false Displayed(tab/group)=Loop-free Alternate Exclude (Protocol Properties) |
| lsaChecksumSum |
type=long access=read-only default=0 Displayed(tab/group)=LSA Checksum Sum (Protocol Properties/Counters) |
| lsaCount |
type=long access=read-only default=0 Displayed(tab/group)=LSA Count (Protocol Properties/Counters) |
| md5TransmitKeyId |
type=int access=read-only default=0 minimum=0 maximum=255 |
| metric |
specifies the desired metric value assigned to this interface. The default value
'0' causes the value of the metric to be calculated as
(Reference Bandwidth / ifSpeed).
type=int default=0 minimum=0 maximum=65535 Displayed(tab/group)=Metric (Protocol Properties) |
| mtu |
Specifies the desired size of the largest packet which can be sent/received
on this OSPF interface, specified in octets. This size DOES include the
underlying IP header length, but not the underlying layer headers/trailers.
The valid range for this property is 0|512..9198.
For SR 7x50 nodes from 19.10 onwards the range is 0|512..9786.
type=int default=0 minimum=0 maximum=9786 units=bytes Displayed(tab/group)=Configured MTU (/Frame Size Constraints) |
| neighborCount |
type=long access=read-only default=0 Displayed(tab/group)=Neighbor Count (Protocol Properties/Counters) |
| networkType |
type=int access=read-only default=transit Displayed(tab/group)=Network Type (Protocol Properties) enums= 1: stub - Stub 2: transit - Transit |
| nodeSID |
Specifies the value of the label or index to be used for the prefix representing the primary address of the
network interface of type 'loopback'.
type=long default=0 minimum=0 maximum=4294967295 Displayed(tab/group)=Node SID Value (Segment Routing/Segment Routing) |
| nodeSIDClearNFlag |
Specifies whether the node-sid flag (N-flag) should be cleared in a prefix SID sub-TLV on loopback interface.
When the nodeSIDClearNFlag is 'false' the prefix SID sub-TLV for the prefix of a loopback interface will belongs to this node only.
If it is 'true' the same prefix SID sub-TLV will be advertised by multiple nodes.
type=boolean default=false Displayed(tab/group)=Node SID Clear N-Flag (Segment Routing/Segment Routing) |
| nodeSIDType |
Specifies what type of value is to be used for the prefix representing the primary address of the
network interface of type 'loopback'.
type=isis.SIDType default=none Displayed(tab/group)=Node SID Type (Segment Routing/Segment Routing) |
| operMetric |
The value indicates the metric value this interface is using.
The default value of the Metric is (Reference Bandwidth / ifSpeed).
The value of the reference bandwidth is configured by the
tmnxOspfReferenceBandwidth object (ifBaseRefCost on the Site).
type=int access=read-only default=0 minimum=0 maximum=65535 Displayed(tab/group)=Operational Metric (Protocol Properties) |
| operationalMtu |
type=int access=read-only default=0 units=bytes Displayed(tab/group)=Operational MTU (/Frame Size Constraints) |
| ospf.InterfaceFlexibleAlgorithm-Set |
type=Children-Set |
| ospf.Md5Key-Set |
type=Children-Set |
| ospf.NBMANeighbor-Set |
type=Children-Set |
| ospf.Neighbor-Set |
type=Children-Set |
| ospf.SegmentRoutingAdjacencySetBinding-Set |
type=Children-Set |
| ospfIfInboundSAName |
type=string default= minimum=0 maximum=32 |
| ospfIfInboundSANamePointer |
type=Pointer default= Displayed(tab/group)=IPsec In Static Security Association (IPsec Static SA) |
| ospfIfOutboundSAName |
type=string default= minimum=0 maximum=32 |
| ospfIfOutboundSANamePointer |
type=Pointer default= Displayed(tab/group)=IPsec Out Static Security Association (IPsec Static SA) |
| ospfNgIfAdvRtrCapability |
The value of ospfNgIfAdvRtrCapability specifies whether or not advertise-router-capabilities
are enabled at interface level.
type=boolean default=true Displayed(tab/group)=Enable Advertise Router Capability (Protocol Properties) |
| ospfNgIfLsaFilterOut |
The value of ospfNgIfLsaFilterOut specifies whether or not
flooded LSA's should be sent to any adjacent neighbor on the OSPF
interface.
type=ospf.OspfLsaFilterOutTc default=none Displayed(tab/group)=LSA Filter Out (Protocol Properties) |
| pollInterval |
type=long default=120 minimum=0 maximum=4294967295 units=seconds Displayed(tab/group)=Poll Interval (Protocol Properties/Intervals) |
| priority |
type=int default=1 minimum=0 maximum=255 Displayed(tab/group)=Priority (Protocol Properties) |
| rca.Problem-Set |
type=Children-Set |
| remainDownOnFailure |
this value specifies whether remain-down-on-failure is enabled or not under BFD.
When bfdEnabled is set to 'false', then remainDownOnFailure should also set to 'false'.
type=boolean Displayed(tab/group)=Remain Down on BFD Failure (Protocol Properties) |
| retransmissionInterval |
type=int default=5 minimum=1 maximum=1800 units=seconds Displayed(tab/group)=Retransmission Interval (Protocol Properties/Intervals) |
| ribPriority |
Specifies whether or not routes via this interface should get priority when downloading to FIB.
If the value is 'high', then these routes are downloaded to FIB before other routes.
type=ospf.RibPriority default=none Displayed(tab/group)=RIB Priority (Protocol Properties) |
| routeNextHopPointer |
The value specifies the next-hop template that must be applied to the prefixes which primary
next-hop uses this interface name.
type=Pointer default= Displayed(tab/group)=Route Next-Hop Policy (Policies/LFA - Route Next-Hop Policy Template) |
| routerDeadInterval |
type=int default=40 minimum=0 maximum=2147483647 units=seconds Displayed(tab/group)=Router Dead Interval (Protocol Properties/Intervals) |
| sidProtection |
Specifies whether the SID needs to be advertised with protection enabled or disabled.
If the value is disabled, no protection is calculated and a single SID with B-flag cleared is
sent in adjacency SID sub-TLV.
If the value is enabled, SID protection is provided and a single SID with B-flag set is sent
in adjacency SID sub-TLV.
type=generic.EnabledDisabled default=enabled Displayed(tab/group)=SID Protection (Segment Routing/Segment Routing) |
| teMetric |
Indicates the MPLS TE metric configured for this interface.
type=long access=read-only minimum=0 maximum=16777215 Displayed(tab/group)=TE Metric (Protocol Properties) |
| templateVersionPointer |
Pointer to the template if this object was created from a template.
type=Pointer default= Displayed(tab/group)=Associated Template (Template/Associated Template) |
| transitDelay |
type=int default=1 minimum=1 maximum=1800 units=seconds Displayed(tab/group)=Transit Delay (Protocol Properties/Intervals) |
| unknownLsaChecksumSum |
type=long access=read-only default=0 |
| unknownLsaCount |
type=long access=read-only default=0 |
| version |
type=int access=read-only default=2 Displayed(tab/group)=Version (/Routing Instance) |
| vrfName |
The name of the VPRN site when OSPF is used in a PE-CE connection.
This is used for Multi Vendor purposes
type=string default= minimum=0 maximum=252 |
| Overridden Properties | |
|---|---|
| administrativeState |
default=ospfInterfaceEnabled |
| application |
default=ospf |
| Properties inherited from netw.RouterTerminatingIpInterface |
|---|
| interfaceId, interfaceType, ipAddress, ipAddressMax, ipAddressMin, ipAddressType, isUnnumbered, prefixLength |
| Properties inherited from netw.RouterTerminatingInterface |
|---|
| interfaceClass, serviceId, serviceType, subscriberId |
| Properties inherited from netw.StatefullConnectableInterface |
|---|
| administrativeState, compositeState, encapType, operationalState, resourceState, underlyingResourceState |
| Properties inherited from netw.LogicalInterface |
|---|
| application, description, displayedName, domain, nodeId, nodeName |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
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