Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

Page of 360
RESTCONF/YANG Interface Details 
 
 
Cisco EPN Manager RESTConf NBI Guide  
138
 
 
 
 
OpticalCircuitOchncCFS Retrieval 
4.17
This interface provides the operations to retrieve OpticalCircuitOchncCFS entities. OCHNC 
circuits establish connectivity between two optical nodes on a specified C-band 
wavelength. The connection is made through the ports present on the wavelength 
selective switches, multiplexers, demultiplexer, and add/drop cards. In an OCHNC circuit, 
the wavelength from a source OCH port ingresses to a DWDM system and then egresses 
from the DWDM system to the destination OCH port. 
OpticalCircuitOchncCFS Data 
The table below lists the attributes in the OpticalCircuitOchncCFS 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. 
 
OpticalCircuitO
chncCFS 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. 
activationState 
OpticalCircuitActivatio
nStateEnum 
Need tp move enum from CFS to common model. 
adminState 
IfAdminStatusEnum 
circuitId 
String 
circuitType 
OpticalCircuitTypeEnu
createTime 
datetime 
The time this CFS was created. A service might have few CFS 
version and the createTime is kept per version of the CFS. 
deployed 
boolean 
description 
String 
direction 
OpticalLinkDirectionali
tyEnum 
downstreamPo
werOffset 
float 
Offset of downstream channel. 
frequency 
String 
globalVersion 
long 
ignorePathAlar
ms 
boolean 
Optional parameter, when set the link port alarm status along the 
light path is ignored when creating a circuit. 
isMatched 
boolean 
## Internal use only ##\r\n\r\n This attribute is relevant for the 
discovered CFSes which are identified as CFS version 0.\r\n The 
attribute will be populated and used by the service discovery