Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

 

                                                          RESTConf/Yang Interface 

Details 

 

 

Cisco EPNM RESTConf  NBI  Guide  

 

 

 

213 

 

4.31

This interface provides the operations to retrieve OpticalOchRoute entities. This object 
represents circuit routes for optical channels. 

The table below lists the attributes in the OpticalOchRoute object. Associated objects are 
represented by a collection, for one-to-many associations, or an attribute of the object 
type for one-to-one or many-to-one associates. The role of the object(s) in the association 
provides the name for association attributes. The API traverses selected associations, 
usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects in a single 
request. Attribute names of such associations are followed by an asterisk (*).  
 
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other 
associations are summarized as a string with an entry giving the object type, name, and 
business key for each object in the collection. Some attributes may not be displayed since 
null values and empty associations are not included in the response. 
 

instanceId 

int 

Instance identifier of entity in the database. 

businessKey 

String 

String representation of attribute value(s) that uniquely identify the 
entity or instanceId if no business key defined. 

aEndName 

String 

## Internal use only ## 

aEndOwningEntityI
d 

String 

## Internal use only ## 

aEndParentLinkId 

String 

** Internal Use Only **\r\nThe Port channel id of the parent link for 
the A End if this link belongs to an aggregate link. 

bEndName 

String 

## Internal use only ## 

bEndOwningEntityI
d 

String 

## Internal use only ## 

bEndParentLinkId 

String 

** Internal Use Only **\r\nThe Port channel id of the parent link for 
the B End if this link belongs to an aggregate link. 

category 

LinkCategoryEnu
m 

The link category, which is used for classification (to group Link types). 

circuitId 

String 

 

compositeType 

LinkCompositeTyp
eEnum 

Specifies the inner structure of a link in terms of other links it might 
contain. 

description 

String 

An optional description of the entity. 

emsResourcesIDs 

long 

## Internal use only ##\r\n\r\n This attribute will keep the list of EMS 
resources IDs which associated to this RFS object.\r\nThe attribute will 
be populated for all discovered RFSes aka RFS version 0.\r\n\r\nThe 
following rule apply:\r\n---------------------\r\nIf RFS A is associated to 
RFS B in a containment association such as LinkAggregateLinks the EMS 
resources associated to RFS B will also be associated to RFS 
A.\r\n\r\nThe attribute will be used internally by the Assurance and 
Service Discovery to easily retrieve the list of EMS resources related to