Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

 

                                                          RESTCONF/YANG 

Interface Details 

 

 

Cisco EPNM RESTConf  NBI  Guide  

 

 

 

103 

 

4.11

This interface provides the operations to retrieve OpticalLink entities. This object 
represents a communication pipe between two or more NetworkResource instances by 
connecting instances of the OpticalLinkTerminationPoint belonging to the connected 
network resources. 
 
OpticalLinks are not directional and are allowed to connect multiple (more than two) 
optical termination points in various topologies. Typically, OpticalLinks are established 
between direct neighbor instances of a OpticalLinkTerminationPoint at the same protocol 
layer. The optical termination points at the ends of a OpticalLink belong to the linked 
NetworkResource instances, not to the OpticalLink. The purpose of a OpticalLink is to 
establish a communication path between OpticalLinkTerminationPoints; therefore, an 
OpticalLink cannot exist without LinkTerminationPoints. 
OpticalLinks can be simple or composite; a composite OpticalLink is an aggregate of other 
simple or composite OpticalLinks. 

The table below lists the attributes in the OpticalLink 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. 

aEndIPAddress 

String 

- 

aEndName 

String 

## Internal use only ## 

aEndOwningEntityId 

String 

## Internal use only ## 

aEndParentLinkId 

String 

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

bEndIPAddress 

String 

- 

bEndName 

String 

## Internal use only ## 

bEndOwningEntityId 

String 

## Internal use only ## 

bEndParentLinkId 

String 

** Internal Use Only **\r\n The Port channel id of