Cisco Cisco Evolved Programmable Network Manager 1.2 Guia Do Programador
RESTCONF/YANG
Interface Details
Cisco EPNM RESTConf NBI Guide
59
Equipment Retrieval
4.4
This interface provides the operations to retrieve Equipment entities. The object
represents a piece of hardware that has some well-specified function (for example, a line
card, memory board, or power supply).
represents a piece of hardware that has some well-specified function (for example, a line
card, memory board, or power supply).
Equipment Data
The table below lists the attributes in the Equipment 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.
Equipment
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.
instanceId if no business key defined.
administrativeSt
ateCode
ateCode
String
** Deprecated. Will be replaced by an enumerated attribute (possibly a
lookup table) after a proper model review **\r\nThe administrative state
(locked, unlocked, and so on). The administrative state is the result of an
administrative action performed by administrator and/or EMS/NMS SW.
lookup table) after a proper model review **\r\nThe administrative state
(locked, unlocked, and so on). The administrative state is the result of an
administrative action performed by administrator and/or EMS/NMS SW.
assemblyNumb
er
er
String
Indicates the manufacturing assembly number, which is the 'hardware'
identification.
identification.
assemblyRevisio
n
n
String
Indicates the revision of the entity within the assemblyNumber.
cleiCode
String
This object represents the CLEI (Common Language Equipment Identifier)
code for the physical entity. If the physical entity is not present in the system,
or does not have an associated CLEI code, the value of this object will be
null.\r\n\r\nFrom-CISCO-ENTITY-ASSET-MIB : ceAsset.cleI
code for the physical entity. If the physical entity is not present in the system,
or does not have an associated CLEI code, the value of this object will be
null.\r\n\r\nFrom-CISCO-ENTITY-ASSET-MIB : ceAsset.cleI
description
String
An optional description of the entity.
deviationNumb
er
er
String
Revision number (signifying a minor deviation) of a module, port adapter, and
so on. Typically this number is required in FN (Field Notice) reports provided
to customers by a HW vendor.
so on. Typically this number is required in FN (Field Notice) reports provided
to customers by a HW vendor.
entPhysicalCont
ainedIn
ainedIn
String
## Internal use only ##
entPhysicalInde
x
x
String
## Internal use only ##
equipmentType
EquipmentTyp
eEnum
eEnum
An indication of the general hardware type of the physical entity. This should
be set to the standard enumeration value that most accurately indicates the
general class of the physical entity or the primary class if there is more than
be set to the standard enumeration value that most accurately indicates the
general class of the physical entity or the primary class if there is more than