Cisco Cisco Evolved Programmable Network Manager 2.0 Guida Dello Sviluppatore

  

 

 

 

Cisco Evolved Programmable Network Manager 2.0.1 RESTCONF API Guide 

 

 

12 

Note the dot (.) prefix in the parameter name. This is required to identify this as a 
special parameter. 

  
The response for the data API always returns a list container with startIndex and lastIndex as first two 
elements of the container data to help with batch sequence. 

Inventory objects represented in this interface has attributes called FDN (Fully Distinguished Name). These 
attributes are used as a reference to the object in query parameters or in the returns data wherever a 
reference to the object is needed.    
 
This FDN is a formatted string that consists of a set of type/value pairs with the following syntax: 
 



 

Sequence of <type>=<value> pairs separated by “!” where:   

o  <type> is a constant value defined in the data model to represent the inventory object in 

the hierarchy, e.g. MD,ND,EQ,PTP,FTP, CTP, TL,VC,CFS, etc.  

o  <value> is any text or sequence of <attrName>=<attrValue> pair separated by “;” that 

represents the attribute/value pairs of the inventory object constitutes a unique value 
within the local scope of the object represented by the type. 

 

The following are some examples for the FDNs: 
 



 

Node FDN=  “MD=CISCO_EPNM!ND=asr9k-cluster.cisco.com” 



 

Equipment FDN =  “MD=CISCO_EPNM!ND=asr9k-cluster.cisco.com!EQ=name=subslot 0/3 
transceiver 0;partnumber=ONS-SI-155-SR-MM”  



 

Termination Point FDN =  “MD=CISCO_EPNM!ND=cvg-frodo-
220.cisco.com!CTP=name=ODU20/1/0/0/2;LR=LR_OCH_Data_Unit_2” 

 

Note: It is assumed that the devices in the network managed by Cisco EPN Manager have unique names and that 
this is continuously ensured by the network operator. If two or more devices have the same name, the API will not 
produce consistent results when using the Object Name as input to any of the APIs. 

The RESTCONF Resource paths in Cisco EPN Manager are secured. To access these Resource paths, use basic 
HTTP authentication. 

User credentials passed for accessing the RESTCONF Resource paths require authorization to use the API. This 
authorization can be configured using Cisco EPN Manager’s security management interface. In Cisco EPN 
Manager, NBI Read privileges are required to perform GET (retrieval) on the RESTCONF data interfaces, 
whereas to use the provisioning interfaces you need NBI Write privileges.  

A Cisco EPN Manager NBI license is required to use RESTCONF NBI Resource path.