Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
RESTCONF/YANG
Interface Details
Cisco EPNM RESTConf NBI Guide
259
OpticalUniRFS Retrieval
4.40
This interface provides the operations to retrieve OpticalUniRFS entities.
OpticalUniRFS Data
The table below lists the attributes in the OpticalUniRFS 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.
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.
OpticalUniRFS
Data
Data
Data Type
Description
instanceId
int
Instance identifier of entity in the database.
aEndName
String
## Internal use only ##
aEndOwningEn
tityId
tityId
String
## Internal use only ##
aEndParentLin
kId
kId
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.
End if this link belongs to an aggregate link.
adminState
ServiceAdminStat
eEnum
eEnum
-
bEndName
String
## Internal use only ##
bEndOwningEn
tityId
tityId
String
## Internal use only ##
bEndParentLin
kId
kId
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.
End if this link belongs to an aggregate link.
category
LinkCategoryEnu
m
m
The link category, which is used for classification (to group Link types).
compositeTyp
e
e
LinkCompositeTyp
eEnum
eEnum
Specifies the inner structure of a link in terms of other links it might contain.
description
String
An optional description of the entity.
discoveryState
DiscoveryStateEn
um
um
-
emsResourcesI
Ds
Ds
long
## Internal use only ##\r\n\r\n This attribute will keep the list of EMS
resources IDs which associated to this RFS object.\r\nThe attribute will be
populated for all discovered RFSes aka RFS version 0.\r\n\r\nThe following
rule apply:\r\n---------------------\r\nIf RFS A is associated to RFS B in a
containment association such as LinkAggregateLinks the EMS resources
associated to RFS B will also be associated to RFS A.\r\n\r\nThe attribute
will be used internally by the Assurance and Service Discovery to easily
retrieve the list of EMS resources related to a RFS object.
resources IDs which associated to this RFS object.\r\nThe attribute will be
populated for all discovered RFSes aka RFS version 0.\r\n\r\nThe following
rule apply:\r\n---------------------\r\nIf RFS A is associated to RFS B in a
containment association such as LinkAggregateLinks the EMS resources
associated to RFS B will also be associated to RFS A.\r\n\r\nThe attribute
will be used internally by the Assurance and Service Discovery to easily
retrieve the list of EMS resources related to a RFS object.