Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

 

                                                          RESTConf/Yang Interface 

Details 

 

 

Cisco EPNM RESTConf  NBI  Guide  

 

 

 

89 

 

4.8

This interface provides the operations to retrieve OpticalPhysicalProtocolEndpoint entities. 
A subclass of PhysicalProtocolEndpoint, this object represents the end point related to a 
physical protocol for an optical device. Note that this is NOT a physical entity, but a logical 
entity that represents media information. In contrast, the associated physical entity, such 
as a USB connector, is represented by the class PhysicalConnector or one of its subclasses. 

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

alarmStatus 

AlarmSeverityEnu
m 

## Internal use only ##\r\nRaw MIB data - parsed into 
supportedSpeeds and supportsAutoSpeed 

clocking 

PhysicalLayerCloc
kingEnum 

Indicates the clocking mechanism that is being used. 

comments 

String 

Contains comments added to a subclass of ProtocolEndpoint. 

description 

String 

An optional description of the entity. 

doAutoNegotiation 

boolean 

Indicates whether the element should negotiate speed, duplex, 
and/or link characteristics (such as flow control). 

entPhysicalIndex 

String 

## Internal use only ## 

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. 

isInternalPort 

boolean 

Indicates whether this is a device internal port (for example, 
used for internal communication only). 

layerRate 

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