Overview Package Class Deprecated Help

ethring
Ring

The Ring object defines a network-wide Ethernet Ring.

public class Ring

Properties
autoCreateGlobalMeg Specifies if the Path should automatically Generate Global MEG during creation.

type=boolean
default=false
Displayed(tab/group)=Auto Create Global MEG (/Path CFM Defaults)
autoRunCCM When the Global MEG is created, setting this property to 'true' will create Maintenance Entity Groups, MEPs and synchronize Remote MEPs on the two path endpoints. On the MEPs, the administrativeState property will be set to 'Up', controlMep property will be set to 'true' and ccEnable will be set to 'true'.

type=boolean
default=false
Displayed(tab/group)=Run CCM On Create (/Path CFM Defaults)
ccTestPtrs The list of Global MEGs used by this Ring.

type=Set (Pointer)
access=read-only
ccmInterval Specifies the ccm-interval to use on the Generated MEGs.

type=ethernettunnel.CCMInterval
default=CCM100ms
Displayed(tab/group)=CCM Interval (/Path CFM Defaults)
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 (/Elements)
elementId The Element ID parameter specifies a unique identifier for the Ethernet ring. The range is 1 to 128. The default is 0, which means that the ID is automatically assigned.

type=int
access=read-create
default=0
minimum=1
maximum=128
Displayed(tab/group)=Element ID
ethring.Interconnect-Set type=Children-Set
ethring.Path-Set type=Children-Set
flowThruSvcPtrs The list of Services that are using this tunnel.

type=Set (Pointer)
access=read-only
isTunnelBeingUsed This property specifies whether a service tunnel is being used or not.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Used By a Service (/Service Tunnel)
maintDomainPointer The pointer to the Maintenance Domain.

type=Pointer
default=
Displayed(tab/group)=Maintenance Domain (/Path CFM Defaults)
megLevel

type=int
access=read-only
default=0
minimum=0
maximum=7
numberOfInterconnects

type=int
access=read-only
default=0
Displayed(tab/group)=Number Of Interconnects (/Status)
operationalFlags Specifies the conditions that affect the operating status of this Ethernet Ring.

type=ethring.RingOperFlags
access=read-only
Displayed(tab/group)=Operational Flags (/Status)
ringCreationOrigin Specifies the creation origin of this ring.

type=ethring.RingCreationOrigin
access=read-only
Displayed(tab/group)=Ring Creation Origin
ringElementType Specifies the creation origin of this ring.

type=ethring.RingElementType
default=sr
Displayed(tab/group)=Element Type
ringOperState

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

type=ethring.RingState
access=read-only
default=none
Displayed(tab/group)=Protection State (/Status)
steerParamInclude A bitmap used to determine which Tunnel Admin Groups are currently included for this service tunnel.

type=long
default=0
units=bitmap
Displayed(tab/group)=Included (/Tunnel Admin Groups)
svcConnectionType The connection between the service and the service tunnel

type=svt.ConnectionType
access=read-only
default=mp
Displayed(tab/group)=Connection Type (/Service Tunnel)
svcTunnelPtrs The list of Service Tunnels that are being used by this service.

type=Set (Pointer)
access=read-only
svcTunnelType The type of service tunnel

type=svt.TunnelType
access=read-only
default=ethRing
Displayed(tab/group)=Tunnel Type (/Service Tunnel)
vlanApplicationType Specifies the creation origin of this ring.

type=ethring.VlanApplicationType
default=standardVlan
Displayed(tab/group)=VLAN Application Type (/Control Service Defaults)
vlanControlServicePointer The pointer to the VLAN control service

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=VLAN Control Service (/Control Service Defaults)
 
Overridden Properties
holdTimeDown The Hold Time Down (centiseconds) parameter specifies the delay between detecting that the member path is down and reporting the status to the G.8032 protection module. This parameter applies only to member path CCM and not to the member port link state. The parameter refers to both the global ring and the ring endpoint.

units=centiseconds
id

revertTime Specifies the Wait-To-Restore (WTR) timer. A value of 0 means non-revertive mode.

default=300
 
Properties inherited from ethring.AbstractRing
elementPointers, guardTime, holdTimeDown, numberOfElements, numberOfVlanElements
 
Properties inherited from ethernettunnel.AbstractAPSGroup
aggrEndPtOperationalState, description, displayedName, holdTimeDown, holdTimeUp, id, numberOfPaths, revertTime
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

addElement

Adds Ethernet Ring Element(s) to this Ethernet Ring.
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.
aInFdns : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

ccmStartAll

Start all CcmTests associated to this Ring, Each Path that has a Global MEG will Execute its corresponding CcmTest. Starting will Enable CC Protocol flags on all MEPs in Path and create Remote MEP lists.
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

ccmStopAll

Start all CcmTests associated to this Ring, Each Path that has a Global MEG will Stop its corresponding CcmTest. Stopping will Disable CC Protocol flags on all MEPs in Path and cleanup Remote MEP lists.
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

createControlService

Creates the Control Service for this Ethernet Ring using the parameters specified.
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.
aInCustomerFdn : string - (Optional) The FDN of the Customer to use in the resulting Control Service if no Service Template is specified. If a Service Template is specified the Customer will be read from there.
aInControlServiceTemplateFdn : string - (Optional) VPLS Service template that contains a Site child which contains an L2AccessInterface child to be used as needed during object creation.
aInUpperRingOuterEncap : int - (Optional) The outer encapsulation value to be used on virtual sub-ring Control Service SAPs which use upper ring Data Services to pass control traffic.
aInUpperRingInnerEncap : int - (Optional) The inner encapsulation value to be used on virtual sub-ring Control Service SAPs which use upper ring Data Services to pass control traffic.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
serviceFdn : string - The FDN of the resulting Control Service.

createDataService

Creates the Data Service for this Ethernet Ring using the parameters specified.
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.
aInCustomerFdn : string - (Optional) The FDN of the Customer to use in the resulting Data Service if not using an existing Data Service and no Service Template is specified. If a Service Template is specified the Customer will be read from there.
aInDataServiceTemplateFdn : string - (Optional) VPLS Service template that contains a Site, ISite or BSite child which contains an L2AccessInterface, IL2AccessInterface or BL2AccessInterface child to be used as needed during object creation.
aInExistingDataServiceFdn : string - (Optional) If specified, new Sites and SAPs will be added to this data service rather than creating a new Data Service. The aInDataServiceTemplateFdn parameter will still be used when creating these Site and SAP objects.
aInDataServiceOuterEncap : int - (Optional) The outer encapsulation value to be used on all Data Service SAPs in the created (sub)ring.
aInDataServiceInnerEncap : int - (Optional) The inner encapsulation value to be used on all Data Service SAPs in the created (sub)ring.
aInSiteIds : Set (string) - (Optional) Only consider rings that have the defined siteIds.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
serviceFdn : string - The FDN of the resulting Data Service.

createDataServicePathSearch

Creates the Data Service for this Ethernet Ring using the parameters specified.
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.
aInExistingDataServiceFdn : string - If specified, new Sites and SAPs will be added to this data service rather than creating a new Data Service. The aInDataServiceTemplateFdn parameter will still be used when creating these Site and SAP objects.
aInDataServiceTemplateFdn : string - VPLS Service template that contains a Site, ISite or BSite child which contains an L2AccessInterface, IL2AccessInterface or BL2AccessInterface child to be used as needed during object creation.
aInDataServiceOuterEncap : int - The outer encapsulation value to be used on all Data Service SAPs in the created (sub)ring.
aInDataServiceInnerEncap : int - The inner encapsulation value to be used on all Data Service SAPs in the created (sub)ring.
aInTspFdn : string - The Tunnel Selection Profile to be used when performing Path Search.
aInSiteIds : Set (string) - Only consider rings that have the defined siteId's.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
serviceFdn : string - The FDN of the resulting Data Service.

createElement

Creates an Ethernet Ring Element and adds it to this Ethernet Ring.
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.
aInElementList : List (generic.CommonManagedEntityConfigurationInformation) -
autoConfigureMissingControlServices : boolean - (Optional) This parameter is applicable only if the ring element type is aos. If set to true, the VLAN service sites and the access interfaces/NNI bindings are automatically configured ports used as path endpoints.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
resultList : List (string) - Resulting objects list.
Exceptions:
ethring.Ring.createElementException

createTransitService

Creates the Transit Service for this Ethernet Ring using the parameters specified.
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.
aInCustomerFdn : string - (Optional) The FDN of the Customer to use in the resulting Transit Service if no Service Template is specified. If a Service Template is specified the Customer will be read from there.
aInControlServiceTemplateFdn : string - (Optional) VPLS Service template that contains a Site child which contains an L2AccessInterface child to be used as needed during object creation.
aInDataServiceOuterEncap : int - (Optional) The outer encapsulation value to be used on all Transit Service SAPs in the created (sub)ring.
aInDataServiceInnerEncap : int - (Optional) The inner encapsulation value to be used on all Transit Service SAPs in the created (sub)ring.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
serviceFdn : string - The FDN of the resulting Transit Service.

globalRingAuditCheck

Checks to see if all ethernet rings appear to be fully configured (based on number of elements, paths, interconnects, path endpoints, and operational flags of the ring).
Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
ringAuditResults : List (Any) - The result of the global ring audit.

removeElement

Removes Element(s) from this Ethernet Ring.
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.
aInFdns : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
ethring.Ring.removeElementException

ringAuditCheck

Checks to see if the ethernet ring appears to be fully configured (based on number of elements, paths, interconnects, path endpoints, and operational flags of the ring).
Input Parameters:
instanceFullName : string - the full name of the object.
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:
ringAuditResult : ethring.RingAuditResult - The result of the ring audit.

updateDataServices

Update all data services associated with this ring, allowing for cut-in/cut-out
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
Output Parameters:
udpateDataServicesResult : int - Returns number of data services updated.