unspRXDeviceMgr.idl
The following IDL is the definition of unspRXDeviceMgr.idl:
#ifndef unspRXDeviceMgr_idl#define unspRXDeviceMgr_idl// ********************************// * *// * unspRXDeviceMgr.idl *// * *// ********************************//Include list#include "globaldefs.idl"#include "common.idl"#pragma prefix "nmcrx.unspcorbabridge.provisioningservice.services.redstonecom.com"module unspRXDeviceMgr{/*** UnspRXDeviceMgrObjectType defined all possible object types for NMC-RX to manage*/enum UnspRXDeviceMgrObjectType{// Layered Objects // Examples:EMS, // "Juniper NMC-RX"ManagedElement, // "10.6.129.6"PTP, // "6/0" - where 6 is the slot number, and 0 is the port numberAtmInterface, // "ATM6/0-atm-layer",AtmSubInterface, // "ATM6/0.1-atm1483-subif",AtmPvc, // "ATM6/0.1-atm1483-subif vpi=1,vci=600"PPP, // not supportedPPPoE, // not supportedPPPoESubInterface, // not supportedBridgedIP_rfc1483, // "4/0.10"VirtualRouter, // "default", "VR1"IpInterface,Customer,CustSite,BridgeInterface // "BridgeIf6/0.1"};/*** UnspRXDeviceMgrObjectTypeList is a list UnspRXDeviceMgrObjectType*/typedef sequence<UnspRXDeviceMgrObjectType> UnspRXDeviceMgrObjectTypeList;/*** UnspRXActionType defined all possible action types* for NMC-RX to manage E-series routers*/enum UnspRXActionType{CREATE,CONFIGURE,LIST,VIEW,DELETE};/*** UnspRXActionTypeList is a list UnspRXActionType*/typedef sequence<UnspRXActionType> UnspRXActionTypeList;/*** UnspRXDeviceMgr_I defines all methods to manage objects* under ERX. It is derived from common::Common_I, which is* one of the idls defined by TMF 814.*/interface UnspRXDeviceMgr_I : common::Common_I{/*** This method should be used to list all objects of a particular type relative* to another object.** The retrieval mechanism follows the paradigm established in TMF 814* and is described below:** objectPath: The name-value pair list of the objects you want to list relative to other objects.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"** ListAll AtmPvc relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"** objectType: The type of objects that you want to list* Example:* UnspRXDeviceMgrObjectType.AtmSubInterfaces* UnspRXDeviceMgrObjectType.AtmPvc** howMany: The maximum number of objects to report in the first batch in nameList** nameList: First batch of howMany objects report to NMS** nameIt: Iterator to retrieve the remaining object after the first batch* To allow the NMS to deal more easily with retrievals which may return a* very large amount of data, iterators are used. They provide a mechanism to retrieve* data batch by batch - the size of a batch is specified by the NMS via the* how_many parameter in the next_n method of the iterator reference.* For a more detailed explanation of the use of iterators, please refer to* TMF814\supportingDocumentation\iterators.html* Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void listAll(in globaldefs::NVSList_T objectPath,in UnspRXDeviceMgrObjectType objectType,in long howMany,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);/*** This list works the same as the other one except that it returns only those objects created* after timeStamp. Also, objects are sorted by timeStamp when they are returned.*/void listAllFromTime(in globaldefs::NVSList_T objectPath,in UnspRXDeviceMgrObjectType objectType,in string timeStamp,in long howMany,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);/*** This method should be used to create an object of a particular type.** objectPath: The name-value pair list of the objects you want to create.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"* Name="AtmSubInterfaces",Value="ATM6/0.1-atm1483-subif"* Name="AtmPvc", Value="ATM6/0.1-atm1483-subif vpi=1,vci=600"** objectType: The type of objects that you want to list* Example:* UnspRXDeviceMgrObjectType.AtmPvc** attributesList: It will hold all attributes as a name-value pair list* to pass to NMC-RX to create this object** objectName: The object name has just been created by this method. It is assigned* by device instead of being specified by the user** Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void create(in globaldefs::NVSList_T objectPath,in UnspRXDeviceMgrObjectType objectType,in globaldefs::NVSList_T attributesList,out string objectName )raises(globaldefs::ProcessingFailureException);/*** This method should be used to configure objects** objectPath: The name-value pair list of the object you want to configure.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"* Name="AtmSubInterfaces",Value="ATM6/0.1-atm1483-subif"* Name="AtmPvc", Value="ATM6/0.1-atm1483-subif vpi=1,vci=600"** attributesList: It will hold all attributes as name value pair list* to pass to NMC-RX to configure this object.* Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of a nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void config(in globaldefs::NVSList_T objectPath,in globaldefs::NVSList_T attributesList)raises(globaldefs::ProcessingFailureException);/*** This method should be used to delete an object** objectPath: The name-value pair list of the object you want to delete.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"* Name="AtmSubInterfaces",Value="ATM6/0.1-atm1483-subif"* Name="AtmPvc", Value="ATM6/0.1-atm1483-subif vpi=1,vci=600"* Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void delete(in globaldefs::NVSList_T objectPath)raises(globaldefs::ProcessingFailureException);/*** This method should be used to view an object** objectPath: The name-value pair list of the object you want to view.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"* Name="AtmSubInterfaces",Value="ATM6/0.1-atm1483-subif"* Name="AtmPvc", Value="ATM6/0.1-atm1483-subif vpi=1,vci=600"** attributesList: It will hold all attributes as the name value pair list* to pass back to NMS to view this object.* Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void view(in globaldefs::NVSList_T objectPath,out globaldefs::NVSList_T attributesList)raises(globaldefs::ProcessingFailureException);/*** This method should be used to get the attributes descriptions in order* to create an object** objectPath: The name-value pair list of the object you want to view.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"* Name="AtmSubInterfaces",Value="ATM6/0.1-atm1483-subif"** objectType: The type of objects that you want to create* Example:* UnspRXDeviceMgrObjectType.AtmPvc** attributesDescription: It will hold all attributes with their description* as name-value pair list to pass back to NMS.* The name will be the attribute name, but the value* will have the attribute type and the description of* this attribute, seperated by the first ":".* Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void getCreateAttributesDescription(in globaldefs::NVSList_T objectPath,in UnspRXDeviceMgrObjectType objectType,out globaldefs::NVSList_T attributesDescription)raises(globaldefs::ProcessingFailureException);/*** This method should be used to get the attributes description in order* to config an object** objectPath: The name-value pair list of the object you want to view.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"* Name="AtmSubInterfaces",Value="ATM6/0.1-atm1483-subif"** attributesDescription: It will hold all attributes with their description* as name-value pair list to pass back to NMS.* The name will be the attribute name, but the value* will have the attribute type and the description of* this attribute, seperated by the first ":".* Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void getConfigureAttributesDescription(in globaldefs::NVSList_T objectPath,out globaldefs::NVSList_T attributesDescription)raises(globaldefs::ProcessingFailureException);/*** This method should be used to get a list of object types on which you can perform a list of* actions relative to other objects.** objectPath: The name-value pair list of the object you want to view.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"* Name="AtmSubInterfaces",Value="ATM6/0.1-atm1483-subif"** objectTypeList: To hold a list of object types** Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void getListableObjectTypeSelections(in globaldefs::NVSList_T objectPath,out UnspRXDeviceMgrObjectTypeList objectTypeList)raises(globaldefs::ProcessingFailureException);/*** This method should be used to get a list of object types on which you can create* actions relative to other objects.** objectPath: The name-value pair list of the object you want to view.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"* Name="AtmSubInterfaces",Value="ATM6/0.1-atm1483-subif"** objectTypeList: To hold a list of object types** Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void getCreatableObjectTypeSelections(in globaldefs::NVSList_T objectPath,out UnspRXDeviceMgrObjectTypeList objectTypeList)raises(globaldefs::ProcessingFailureException);/*** This method should be used to get a list of types of actions you can perform* relative to other objects.** objectPath: The name-value pair list of the objects you want to view.* Example:* ListAll AtmSubInterfaces relative to objectPath* Name="EMS", Value="Juniper NMC-RX"* Name="ManagedElement", Value="10.6.129.6"* Name="PTP", Value="6/0"* Name="AtmInterface", Value="ATM6/0-atm-layer"* Name="AtmSubInterfaces",Value="ATM6/0.1-atm1483-subif"** objectTypeList: To hold a list of action types** Raises: globaldefs::ProcessingFailureException* EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure* EXCPT_INVALID_INPUT - Raised when the invalid input is passed into this method* EXCPT_ENTITY_NOT_FOUND - Raised when objectPath does not reference an existing object* EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS* can support has been reached.* EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost**/void getSupportedActions(in globaldefs::NVSList_T objectPath,out UnspRXActionTypeList actionTypeList)raises(globaldefs::ProcessingFailureException);};};#endifProvisioning Objects
The following sections describe the provisioning objects for this IDL.
Managed Element
A managed element is an E-series device or node.
- juniSystem.mi2
- rfc1213.mib
ERX node system name for the device
The name is displayed on the prompt of the command-line interface. It is not the same as the name assigned by the NMC-RX user when initially discovering the node.
PTP
The Physical Termination Point (PTP) object represents either a module specified at a particular slot, or a line interface specified as a slot and port.
The object path for a module includes the slot number.
The object path for a line interface or port includes the slot number and the port number.
Port (OC3/OC12)
This type of provisioning object has the following associated MIBs:
- rfc1213.mib
- juniSonet.mi2
Port (T3 ATM)
This type of provisioning object has the following associated MIBs:
ATM Interface
The OC3-2 modules do not support MAX VPI and MAX VCI.
The object path for a module includes the slot number.
- Name=
EMS; Value=JUNIPER_NMCRX- Name=
ManagedElement; Value=10.10.10.10- Name=
PTP; Value=0/0- Name=
AtmInterface; Value=ATM0/0
- rfc1213.mib
- rfc1695.mi2
- juniAtm.mi2
- af-nm-0095_001_mib.mi2
(atmfM4IfLoopbackLocationCode defined in this MIB)
ATM Subinterface
The object path for a module includes the slot number.
- Name=
EMS; Value=JUNIPER_NMCRX- Name=
ManagedElement; Value=10.10.10.10- Name=
PTP; Value=0/0- Name=
AtmInterface; Value=ATM0/0- Name=
AtmSubInterface; Value=ATM0/0.33
- rfc1213.mib
- juniAtm.mi2
- juniAutoconf.mi2
- juniSubscriber.mi2
- juniTmpl.mi2
- juniQos.mi2
ATM PVC
- Name=
EMS; Value=JUNIPER_NMCRX- Name=
ManagedElement; Value=10.10.10.10- Name=
PTP; Value=0/0- Name=
AtmInterface; Value=ATM0/0- Name=
AtmSubInterface; Value=ATM0/0.33- Name=
AtmPVC; Value=ATM0/0.33.44.55Virtual Router
- Name=
EMS; Value=JUNIPER_NMCRX- Name=
ManagedElement; Value=10.10.10.10- Name=
VirtualRouter; Value=default- Name=
AtmPVC; Value=ATM0/0.33.44.55
- juniRouter.mi2
- juniSscClient.mi2
- juniAaa.mi2
- juniRadClient.mi2
- juniDhcp.mi2
IP Interface
IP interfaces are stacked on a wide variety of interface types and configurations. Object paths reflect these various configurations.
The following shows the object path for an IP interface that is stacked on top of an ATM subinterface.
- Name=
EMS; Value=JUNIPER_NMCRX- Name=
ManagedElement; Value=10.10.10.10- Name=
PTP; Value=0/0- Name=
AtmInterface; Value=ATM0/0- Name=
AtmSubInterface; Value=ATM0/0.33- Name=
IpInterface; Value=IP0/0.33
- juniIp.mi2
Customer and Customer Site
Customer objects can be associated with IP interfaces. The Device Manager provides methods for managing customer and customer site objects. These objects are discussed in unspRXCustomerMgr.idl.
ATM Bridge Support
There are two object types added to support Bridge Interfaces over ATM: BridgedIP_rfc1483 (Bridged Ethernet) and Bridge Interface.
The following shows the object path for an IP interface that is stacked on top of an ATM subinterface.
- Name=
EMS; Value=JUNIPER_NMCRX- Name=
ManagedElement; Value=10.10.10.10- Name=
PTP; Value=0/0- Name=
AtmInterface; Value=ATM0/0- Name=
AtmSubInterface; Value=ATM0/0.33- Name=
BridgedIP_rfc1483; Value=BRG-ET0/0.33
Bridge Interface
- Name=
EMS; Value=JUNIPER_NMCRX- Name=
ManagedElement; Value=10.10.10.10- Name=
PTP; Value=0/0- Name=
AtmInterface; Value=ATM0/0- Name=
AtmSubInterface; Value=ATM0/0.33- Name=
BridgedIP_rfc1483; Value=BRG-ET0/0.33- Name=
BridgeInterface; Value=BridgeIf0/0.33