Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
RESTConf/Yang Interface
Details
Cisco EPNM RESTConf NBI Guide
223
OpticalOchCircuitInfo Retrieval
4.32
This interface provides the operations to retrieve OpticalOchCircuitInfo entities. The object
contains information about the control plane services that perform connection
management for the data plane (the actual forwarding logic) for optical interfaces and
non-packet-switched interfaces. The control plane facilitates four basic functions: routing
control, resource discovery, connection management, and connection restoration.
contains information about the control plane services that perform connection
management for the data plane (the actual forwarding logic) for optical interfaces and
non-packet-switched interfaces. The control plane facilitates four basic functions: routing
control, resource discovery, connection management, and connection restoration.
OpticalOchCircuitInfo Data
The table below lists the attributes in the OpticalOchCircuitInfo 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.
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.
OpticalOchCircuitInfo
Data
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.
uniquely identify the entity or instanceId if no
business key defined.
activationState
OpticalCircuitActivationStateEnum
Need tp move enum from CFS to common
model.
model.
activeOpticalValidatio
nZone
nZone
OpticalValidationZoneEnum
activeValidationMode
OpticalValidationModeEnum
The optical validation required upon circuit
setup.
setup.
activeValidationZoneT
hreshold
hreshold
OpticalValidationZoneEnum
The enum representing the optical quality level
on the circuit path.
on the circuit path.
adminState
IfAdminStatusEnum
circuitIdentifier
String
destinationInterfaceN
ame
ame
String
destionationIpAddress
String
direction
OpticalCircuitDirectionEnum
downstreamPowerOff
set
set
float
Offset of downstream channel.
frequency
String
ignorePathAlarms
boolean
Optional parameter, when set the link port alarm
status along the light path is ignored when
status along the light path is ignored when