Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

Page of 360
 
                                                          RESTCONF/YANG 
Interface Details 
 
 
Cisco EPNM RESTConf  NBI  Guide  
 
 
 
335 
 
OpticalPathOptionRFS Retrieval 
4.60
This interface provides the operations to retrieve OpticalPathOptionRFS entities. The 
object contains path option configuration data for an ODU Tunnel. A label-switched path 
can be dynamically computed by the GMPLS protocol or explicitly specified. This object 
represents the service as discovered from network devices. 
OpticalPathOptionRFS Data 
The table below lists the attributes in the OpticalPathOptionRFS 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. 
 
OpticalPathOptionRFS 
Data 
Data Type 
Description 
instanceId 
int 
Instance identifier of entity in the database. 
explicitPathName 
String 
The name of the explicit path profile. 
index 
int 
Index to manage relationships between path option 
instances. 
lockdown 
boolean 
True if the path is locked. 
subclassname 
String 
The name of the object type. 
type 
OpticalPathOptionTypeEnum  Explicit/dynamic 
protectedBy 
OpticalPathOptionRFS 
restoredFrom 
OpticalPathOptionRFS 
 
Operations 
The table below lists the operations available to retrieve OpticalPathOptionRFS 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