Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
RESTCONF/YANG
Interface Details
Cisco EPNM RESTConf NBI Guide
231
OpticalCircuitOduTunnelRFS Retrieval
4.34
This interface provides the operations to retrieve OpticalCircuitOduTunnelRFS entities.
Resource-facing service for an Optical Data Unit (ODU) tunnel.
Resource-facing service for an Optical Data Unit (ODU) tunnel.
OpticalCircuitOduTunnelRFS Data
The table below lists the attributes in the OpticalCircuitOduTunnelRFS 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.
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.
OpticalCircuitOduTun
nelRFS Data
nelRFS 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.
identify the entity or instanceId if no business key defined.
aEndName
String
## Internal use only ##
aEndOwningEntityId
String
## Internal use only ##
aEndParentLinkId
String
** Internal Use Only **\r\n The Port channel id of the parent
link for the A End if this link belongs to an aggregate link.
link for the A End if this link belongs to an aggregate link.
activePath
OpticalCircuitPathTypeE
num
num
To identify which the path currently used by this service.
adminState
IfAdminStatusEnum
-
bEndName
String
## Internal use only ##
bEndOwningEntityId
String
## Internal use only ##
bEndParentLinkId
String
** Internal Use Only **\r\n The Port channel id of the parent
link for the B End if this link belongs to an aggregate link.
link for the B End if this link belongs to an aggregate link.
bandwidth
OtnOduLevelEnum
category
LinkCategoryEnum
The link category, which is used for classification (to group
Link types).
Link types).
circuitId
String
-
circuitType
OpticalCircuitTypeEnum
Identify the type of Circuit.
compositeType
LinkCompositeTypeEnu
m
m
Specifies the inner structure of a link in terms of other links it
might contain.
might contain.
description
String
An optional description of the entity.
direction
DirectionEnum
-
discoveryState
OpticalCircuitDiscoveryS
tateEnum
tateEnum
The discovery state of the optical circuit.
emsResourcesIDs
long
## Internal use only ##\r\n\r\n This attribute will keep the list
of EMS resources IDs which associated to this RFS
of EMS resources IDs which associated to this RFS