Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

Page of 360
RESTCONF/YANG Interface Details 
 
 
Cisco EPN Manager RESTConf NBI Guide  
100
 
 
 
 
Optical Interface Protocol Endpoint Retrieval 
4.10
This interface provides the operations to retrieve OpticalInterfacePEP entities. This object 
represents an end point on an optical interface. 
OpticalInterfacePEP Data 
The table below lists the attributes in the OpticalInterfacePEP 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. 
 
OpticalInterface
PEP Data 
Data Type 
Description 
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. 
adaptationPepLa
yerRate 
LayerRateEnum 
adaptationPepNa
me 
String 
alarmStatus 
AlarmSeverityE
num 
## Internal use only ##\r\nRaw MIB data - parsed into supportedSpeeds 
and supportsAutoSpeed 
comments 
String 
Contains comments added to a subclass of ProtocolEndpoint. 
description 
String 
An optional description of the entity. 
direction 
OpticalDirectio
nEnum 
 
fdn 
String 
The fully qualified domain name (FDN) for the equipment (or equipment 
subclass) instance. 
isFloatingPep 
boolean 
Indicates whether a ProtocolEndpoint is related to a ResourceAccessPoint. 
If not, this ProtocolEndpoint is known as a floating PEP. 
isMonitored 
boolean 
Return true if the PEP is monitored, false otherwise. 
layerRate 
LayerRateEnum 
lowerLayerPepN
ame 
String 
lowerLayerRate 
LayerRateEnum 
mtosiLabel 
String 
!!! this attribute is only to be used by the MTOSI NBI. It's format and 
population cannot be relied upon and may change without notice !!! 
name 
String 
The name of the entity. 
opticalAggregate
dPEPName 
String 
owningEntityId 
String 
## Internal use only ##