Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

 

                                                          RESTConf/Yang Interface 

Details 

 

 

Cisco EPNM RESTConf  NBI  Guide  

 

 

 

31 

 

4.2

This interface provides the operations to retrieve ManagedElement entities. This object 
represents a device managed by EPNM. 

The table below lists the attributes in the ManagedElement 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. 
 

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. 

clusterCount 

int 

 

collectionStatus 

String 

A detailed status of inventory collection - Success or failure. 

collectionTime 

datetime 

 

communicationState 

CommunicationStat
eEnum 

Indicates management availability or reachability of the 
managed network element. It can indicate the availability or 
reachability of the management agent serving as a proxy for 
the network element. 

creationTime 

datetime 

 

description 

String 

Description of the MNE. 

fdn 

String 

The fully qualified domain name (FDN) for the equipment (or 
equipment subclass) instance. 

lastBootTime 

datetime 

Represents the time the management agent on the managed 
network element was last rebooted. 

lifecycleState 

LifecycleStateEnum 

Represents the current management state of the network 
element: managed, unmanaged, under maintenance, and so 
on. This state is modified by events in the network and 
network management system, and also by user request. 

managementAddress 

String 

The ip address of the device. This is the preferred 
management access address for the device. This is typically 
an address at which SNMP, telnet, and ssh agents are 
available. 

name 

String 

The name of the MNE. 

owningEntityId 

String 

 

productFamily 

String 

The contents of the NAME attribute of the outer-most 
<DEVICEGROUP> element in a Cisco MDF file for this 
particular instance of ManagedNetworkElement.