ospf
ShamLink

ShamLink describes the sham links that the OSPF Process is configured to carry on.



public class ShamLink

Stats:
ospf.ShamLinkGeneralStats ospf.ShamLinkReceiveStats ospf.ShamLinkStatusStats ospf.ShamLinkTransmitStats

Properties
administrativeState

type=int
default=enabled
Displayed(tab/group)=Administrative State (/States)
enums=
    0: unknown - Unknown (not selectable)
    1: enabled - Up
    2: disabled - Down

areaIdPointer

type=Pointer
default=
Displayed(tab/group)=Area

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)

creationOrigin

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

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

interfaceCtpPointer

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Interface

interfaceInstanceIDonShamLink The value of tmnxOspfShamIfInstId specifies the interface instance ID to be used for the sham link. This ID has local link significance only.

type=long
access=read-only
default=0

interfaceInstanceIndex

type=long
access=read-create
default=0

interfaceInstanceName

type=string
access=read-create
Mandatory on create

localEgressIfIpAddress

type=InetAddress
access=read-only
default=0.0.0.0

localEgressIfIpAddressType

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

lsaChecksumSum

type=long
access=read-only
default=0
Displayed(tab/group)=LSA Checksum (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

type=int
default=1
minimum=1
maximum=65535
Displayed(tab/group)=Metric (Protocol Properties)

neighborCount

type=long
access=read-only
default=0

operationalState

type=netw.OperationalState
access=read-only
default=unknown
Displayed(tab/group)=Operational State (/States)

ospf.Md5Key-Set type=Children-Set
ospf.ShamLinkNeighbor-Set type=Children-Set
retransmissionInterval

type=int
default=5
minimum=1
maximum=1800
units=seconds
Displayed(tab/group)=Retransmission Interval (Protocol Properties/Intervals)

routerDeadInterval

type=int
default=40
minimum=1
maximum=65535
units=seconds
Displayed(tab/group)=Router Dead Interval (Protocol Properties/Intervals)

routerId

type=int
access=read-only
default=1
minimum=1
maximum=10240
Displayed(tab/group)=Routing Instance ID (/Routing Instance)

routerName

type=string
access=read-only
default=
minimum=0
maximum=32
Displayed(tab/group)=Routing Instance Name (/Routing Instance)

serviceId

type=long
access=read-only
default=0

serviceType

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

shamNeighborIpAddrType

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

shamNeighborIpAddress

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=Remote Neighbor IP Address

shamNeighborIpAddressType

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

siteId

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=Site ID (/Site)

siteName

type=string
access=read-only
default=0.0.0.0
maximum=252
Displayed(tab/group)=Site Name (/Site)

subscriberId

type=long
access=read-only
default=0

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

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

removePassword

Input Parameters:
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
Supported Network Elements
7705 SAR Supported from 21.4.R1
7705 SAR H Supported from 21.4.R1
7750 SR Supported from 7.0.R1
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported from 8.0.R1 until 10.0.R1
  • Excluded chassis types: 7450-ESS1, 7450-ESS6, 7450-ESS6V
  • Required Capabilities: MixedMode
Supported from 10.0.R1
  • Excluded chassis types: 7450-ESS1
  • Required Capabilities: MixedMode
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
7210 SAS R Supported from 7.0.R1
7210 SAS X Supported from 7.0.R1
7210 SAS T Supported from 7.0.R1
  • Required Capabilities: NetworkMode
7210 SAS K Supported from 9.0.R3
  • Required Capabilities: NetworkMode
7210 SAS Mxp Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS S/Sx
7250 IXR
Product Specifics
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 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 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
7250 IXR (all versions)
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
7705 SAR Gen 2 (all versions)
7705 SAR Gen 2 25.0
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
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 (all versions)