Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Page of 637
 
MTOSI Interface Details 
 
 
 
 
 
 
Cisco EPN Manager 2.0 MTOSI API Guide for OSS Integration  
 
 
36 
Equipment Data 
Data Type 
Description 
hostRedundancyStatus 
String 
Host redundancy status. 
 
4.3.2  Operations 
4.3.2.1  getEquipment 
This operation retrieves information about a specified equipment instance. 
4.3.2.1.1 Input 
Request Parameter 
Data Type 
Description 
equipmentOrEhRef 
 
NamingAttributeType 
Set of RDNs representing equipment or equipment 
holder for which data is being retrieved.    
4.3.2.1.2 Output 
Response Data 
Data Type 
Description 
equipmentOrEhList 
 
EquipmentOrEquipmentHolde
rType 
 
Holder that contains the Eq or Eh details.  
See equipment details table for data 
returns for each equipment. 
4.3.2.1.3 Exceptions 
internalError: Indicates that an internal error or exception has occurred as part of this call. 
invalidInput: Indicates that the input given to the operation is invalid.  
 
4.3.2.2  getAllEquipment 
This operation retrieves complete information about all equipment instances in the network.  
 
4.3.2.2.1 Input 
Request Parameter 
Data Type 
Description 
requestedBatchSize 
integer 
Maximum number of objects to return.  
getAllEquipmentRequest 
 
getAllEquipmentRequ
est 
 
Request element. May contain additional 
granularity input, or may be empty while 
returning every equipment in system. 
meOrEhRef 
NamingAttributeType 
Set of RDNs representing the managed element 
or equipment holder in which the equipment is 
to be found. 
4.3.2.2.2 Output 
Response Data 
Data Type 
Description 
getAllEquipmentRes
ponse 
 
getAllEquipmentRe
sponseType 
Holder element that contains the list of equipment or 
equipment holders. Data representing each object (equipment 
or equipment holder) is defined in equipment data table (in 
interface section). 
4.3.2.2.3 Exceptions 
internalError: Indicates that an internal error or exception has occurred as part of this call. 
invalidInput: Indicates that the input given to the operation is invalid.  
4.3.2.3  getEquipmentIterator 
This operation returns Equipment information in batches.