Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

RESTConf/Yang Interface Details 

 

 

Cisco EPN Manager RESTConf NBI Guide  
62

 

 

 

udi 

String 

Universal Device Identifier. The UDI is composed by concatenating the 
following values:\r\nPID = Equipment.partNumber\r\nVID = 
Equipment.hardwareVersion\r\nSN = Equipment.serialNumber. 

vendorEquipme
ntType 

String 

An indication of the vendor-specific hardware type of the physical entity. 
Represents an independently extensible type identification value. It can, for 
example, indicate a particular subtree with further MIB definitions, or define a 
particular type of protocol or hardware (for example, 
1.3.6.1.4.1.9.12.3.1.9.3.131).\r\nSee CISCO-ENTITY-VENDORTYPE-OID-MIB. 

connectors * 

Set<PhysicalCo
nnector> 

The set of instances of PhysicalConnectors contained in this piece of 
Equipment. 

containedEquip
ment * 

Set<Equipmen
t> 

A set of instances of Equipment contained in this instance of Equipment. 

occupiedHolder
s 

Set<Equipmen
tHolder> 

The EquipmentHolders occupied by this piece of Equipment.\nOther pieces of 
Equipment provide these Holders. For example: A Module can occupy one or 
two Slots provided by a Chassis. 

 

The table below lists the operations available to retrieve Equipment data from Restconf via 
the http protocol. 
All URLs require basic authentication and can produce: 



 

application/xml 



 

application/yang.data+xml 



 

application/json 



 

application/yang.data+json 

 
The first URL retrieves all the Equipment entities in the database. The next URL returns a 
specific Equipment entity by its business key. Enter the values of the attributes shown in 
the braces, but do not include the braces. The final URL retrieves a specific Equipment by 
its database instance id. Enter the instance id, but do not include the braces. 
 

http://<host>/restconf/v1/data/epnm-restconf-xmp-im-ext-equipment:Equipment 

Retrieve all Equipment 
instances 

http://<host>/restconf/v1/data/epnm-restconf-xmp-im-ext-
equipment:Equipment/{owningEntityId}/{entPhysicalIndex} 

Retrieve Equipment 
instance by business key 

http://<host>/restconf/v1/data/epnm-restconf-xmp-im-ext-
equipment:Equipment/{id} 

Retrieve Equipment 
instance by database 
instance id 

 

This object supports the fully-qualified domain name (FDN) attribute, which is unique for 
all Equipment objects. You may use the FDN as a query parameter to retrieve a specific 
Equipment object as follows: 
 

http://<host>/restconf/v1/data/epnm-restconf-xmp-im-ext-equipment:Equipment?fdn=<value

>