ethring
Element

The Element class defines the configuration for an Ethernet Ring Element on a Network Element.



public class Element

Properties
administrativeState

type=netw.AdministrativeState
default=tmnxOutOfService
Displayed(tab/group)=Administrative State

compatibleVersion The Compatible Version parameter specifies the backward compatibility logic for an Ethernet ring. For the option Version 1, the Force Switch and Manual Switch tool commands are not supported and the Revert Time (seconds) parameter must be set to a non-zero value. Use this option if there is a node in the Ethernet ring that follows version 1 of the ITU-T G.8032 standard. For the Version 2 (default) option, the restrictions listed for the Version 1 option do not apply.

type=ethring.EthRingCompatibleVersion
default=v2
Displayed(tab/group)=Compatible Version

defectStatus Indicates what defects are active on the Ethernet Ring. The defects are defined as: dFopPM -- Provisioning Mismatch

type=ethring.EthRingDefectMask
access=read-only
default=none
Displayed(tab/group)=Ethernet Ring Defect Status

description

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

erpRingType

type=ethring.EthRingErpRingType
access=read-only
default=normal
Displayed(tab/group)=Ring Type

ethernetSwitchCardId

type=long
access=read-only
default=0

ethernetSwitchCardPointer Pointer to the Card Slot which this Element is configured on

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

ethring.ElementBinding-Set type=Children-Set
ethring.PathEndpoint-Set type=Children-Set
guardTime Specifies the guard timer, in deciseconds, of a Ring-APS (R-APS) node. The guard timer is used to prevent the Ethernet Ring node from acting upon outdated R-APS messages and prevent the possibility of forming a closed loop. While the guard timer is running, any received R-APS Request/State and Status information is blocked and not forwarded to the Priority Logic. When the guard timer is not running, the R-APS Request/State and Status information is forwarded unchanged.

type=int
default=5
minimum=1
maximum=20
units=deciseconds
Displayed(tab/group)=Guard Time

holdTimeDown The CCM Hold Time Down (centiseconds) parameter specifies the delay, in centiseconds, used for the hold timer of the associated Continuity Check (CC) session down event dampening. This guards against reporting excessive path operational state transitions. It is implemented by not advertising subsequent transitions of the CC state to the Ethernet Ring Element until the configured timer has expired. A value of 0 specifies that a down transition is reported immediately.

type=int
default=0
minimum=0
maximum=5000
units=centiseconds
Displayed(tab/group)=CCM Hold Time Down

holdTimeUp The CCM Hold Time Up (deciseconds) parameter specifies the delay, in deciseconds, used for the hold timer of the associated Continuity Check (CC) session up event dampening. This guards against reporting excessive path operational state transitions. It is implemented by not advertising subsequent transitions of the CC state to the Ethernet Ring Element until the configured timer has expired. A value of 0 specifies that an up transition is reported immediately.

type=int
default=20
minimum=0
maximum=5000
units=deciseconds
Displayed(tab/group)=CCM Hold Time Up

id

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

interconnectPointer

type=Pointer
access=read-only
default=
Displayed(tab/group)=Ethernet Ring Interconnect (/Sub-Ring)

macAddress The MAC address of the source node.

type=MacAddress
access=read-only
default=00-00-00-00-00-00
Displayed(tab/group)=Originator of R-APS MAC Address (/APS Tx PDU)

megLevel MEG level of the R-APS PDU to be inserted for this Ring. This object must be specified while creating a row in this table. Once the row has been created, the value of this object cannot be changed.

type=int
access=read-create
default=0
minimum=0
maximum=7
Displayed(tab/group)=MEG Level (/Service)

operationalState

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

protectState

type=ethring.MprProtectedStateType
access=read-only
Displayed(tab/group)=Protection State

rapsSiteId

type=string
access=read-only
default=0.0.0.0
Displayed(tab/group)=Originator of R-APS IP Address (/APS Tx PDU)

revertTime Specifies the Wait-To-Restore (WTR) timer, in seconds. The WTR timer is used to prevent frequent operation of the protection switching due to intermittent signal failure defects. The valid range is 60 to 720 seconds. A value of 0 puts the Ethernet Ring Element into a non-revertive mode.

type=int
default=300
minimum=0
maximum=720
units=seconds
Displayed(tab/group)=Revert Time

revertTimeCountDn

type=long
access=read-only
default=0
units=seconds
Displayed(tab/group)=Revert Time Count Down

revertVersionFallback

type=boolean
default=false
Displayed(tab/group)=Revert ERP Version Fallback

revertive

type=boolean
default=true
Displayed(tab/group)=Revertive Mode

ringAlarmProfile > Specifies assigned alarm profile for the ring

DEPRECATED: 23.4 - No longer applicable to any supported nodes
type=Pointer
access=read-only

ringId

type=long
access=read-only
default=0

ringNodeId

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=Ring Node ID

ringPointer

type=Pointer
access=read-only
default=
Displayed(tab/group)=Ethernet Ring Manager

ringVlanId The R-APS Vlan ID parameter is used by the ERP control process to send and receive R-APS PDUs. The range is 2 to 4080. There is no default value for this parameter.

type=int
access=read-create
minimum=2
maximum=4080
Mandatory on create
Displayed(tab/group)=R-APS Vlan Id

rplType Specifies the Ring Protection Link (RPL) type of the Ethernet Ring Element. If this property is set to 'rplNone', the Ethernet Ring Element is not disgnated as either an RPL Owner or Neighbor. If this property is set to 'rplOwner', the Ethernet Ring Element is adjacent to the RPL that is responsible for blocking its end of the RPL under normal conditions. It is the responsibility of the rplOwner for activating reversion behaviour from protected or MS/FS conditions. If this property is set to 'rplNeighbor', the Ethernet Ring Element is adjacent to the RPL that is responsible for blocking its end of the RPL under normal conditions in addition to the block by the RPL Owner Node. The Ethernet Ring Element is not responsible for activating the reversion.

type=ethring.RplNodeType
default=rplNone
Displayed(tab/group)=Ring Protection Link Type

servicePointer

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

siteId

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=Site ID

siteIdAddrType

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

subRingInterconnectId Specifies the id of the Element this Element is interconnected to. A value of 4294967295 specifies that this Element is interconnected to a VPLS service. This property can only be set to 4294967295 if the subRingType is set to 'nonVirtualLink'. A value of 0 specifies that this Element is not interconnected.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Ethernet Ring ID (/Sub-Ring)

subRingPropTopChange Specifies whether or not the Element propagates topology changes to the interconnected Element as specified by the value of subRingInterconnectId.

type=boolean
default=false
Displayed(tab/group)=Propagate Topology Change (/Sub-Ring)

subRingType Specifies whether this Element is a sub-ring or not. A value of 'none' specifies that the Element is not a sub-ring. A value 'virtualLink' specifies that the Element is a sub-ring with R-APS virtual channel. A value of 'nonVirtualLink' specifies that the Element is a sub-ring without R-APS virtual channel.

type=ethring.EthRingSubRingType
default=none
Displayed(tab/group)=Type (/Sub-Ring)

switchCommand

type=ethring.EthRingCmdSwitchEnum
default=ethRingNoCmd
Displayed(tab/group)=Switch Command

switchOAMCriteria Each defect parameter as input to ERP Protocol Machine is represented by a single bit within the value of this object.

type=ethring.ErpDefectList
default=NA
Displayed(tab/group)=Switch Input (/OAM Switch Criteria)

topologyPointer

type=Pointer
default=
Displayed(tab/group)=Radio Ring Topology

txApsPdu

type=string
access=read-only
default=0

txApsPduRequestState

type=ethring.RingApsPduRequestStateEnum
access=read-only
default=NA
Displayed(tab/group)=R-APS Message (/APS Tx PDU)

txApsPduStatus

type=ethring.RingApsPduStatusMask
access=read-only
Displayed(tab/group)=Status (/APS Tx PDU)

txApsPduSubCode

type=ethring.RingApsPduSubCodeEnum
access=read-only
default=NA
Displayed(tab/group)=Sub-Code (/APS Tx PDU)

virtualChannel

type=boolean
default=true
Displayed(tab/group)=Virtual Channel

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
7210 SAS E
7210 SAS M
7210 SAS X
7210 SAS D
7210 SAS K
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7210 SAS R Supported from 6.1.R4
7210 SAS K
Wavence SM Supported from 3.1.0
7750 SR Supported until 11.0.R1
  • Excluded chassis types: 7750-SR1, 7750-SRc12, 7750-SRc4, VSR, VSR-I
Supported from 11.0.R1
  • Excluded chassis types: 7750-SR1, VSR, VSR-I
7450 ESS Supported for all versions
  • Excluded chassis types: 7450-ESS1
7950 XRS
7250 IXR Supported from 20.10.R1 until 24.7.R1
  • Excluded chassis types: 7250 IXR-6, 7250 IXR-10, 7250 IXR-x, 7250 IXR-x3, 7250 IXR-R6d, 7250 IXR-R6dl, 7250 IXR-e2, 7250 IXR-e2c
Supported from 24.7.R1
  • Excluded chassis types: 7250 IXR-6, 7250 IXR-10
OS6850/6850E
OS6855
OS6400
OS6250
OS6450
OS9700E/9800E
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6465
OS6360
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 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
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 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
OS6250 (all versions)
OS6250 6.6.3
OS6250 6.6.4
OS6250 6.6.5
OS6250 6.7.1
OS6360 8.10
OS6360 8.10
OS6360 8.9
OS6360 8.9
OS6400 (all versions)
OS6400 6.4.3
OS6400 6.4.4
OS6400 6.4.5
OS6450 (all versions)
OS6450 6.6.4
OS6450 6.6.5
OS6450 6.7.1
OS6450 6.7.2
OS6465 (all versions)
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 (all versions)
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 (all versions)
OS6570M 8.10
OS6570M 8.10
OS6570M 8.9
OS6850/6850E (all versions)
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 (all versions)
OS6855 6.4.4
OS6855 6.4.5
OS6855 6.4.6
OS6860E/OS6860N (all versions)
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 (all versions)
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 (all versions)
OS6870 8.10
OS6900 (all versions)
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 (all versions)
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