Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Page of 88
 RESTCONF/YANG Interface Details 
 
 
 Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide 
 72
 
 
InterfaceProtocolEndpoint Retrieval 
4.8
This interface provides the operations to retrieve InterfaceProtocolEndpoint entities. This 
object represents entries in the IF-MIB IfTable or their equivalent in IOS or config-file. 
InterfaceProtocolEndpoint Data 
The table below lists the attributes in the InterfaceProtocolEndpoint 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. 
 
InterfaceProtocolEnd
point 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. 
adminStatus 
IfAdminStatusEnum 
Represents the desired state of the interface. 
alarmStatus 
AlarmSeverityEnum 
## 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. 
entAliasMappingIden
tifier 
String 
## Internal use only ## 
fdn 
String 
The fully qualified domain name (FDN) for the equipment 
(or equipment subclass) instance 
ifIndex 
String 
## Internal use only ## 
ifSpeed 
LongQuantity 
Specifies an estimate of the interface's current bandwidth 
in bits per second. For interfaces that do not vary in 
bandwidth or for those where no accurate estimation can 
be made, this should contain the nominal bandwidth. For a 
sublayer that has no concept of bandwidth, this object 
should be zero. 
isConnectorPresent 
MultiStateEnum 
Indicates whether the interface sublayer has a physical 
connector. 
isFloatingPep 
boolean 
Indicates whether a ProtocolEndpoint is related to a 
ResourceAccessPoint. If not, this ProtocolEndpoint is 
known as a floating PEP. 
isPromiscuous 
boolean 
Indicates whether this interface only accepts 
packets/frames that are addressed to its hosting network 
element. This object has a value of true when the station 
accepts all packets/frames transmitted on the media. The