Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
MTOSI Interface Details
Cisco EPN Manager 1.2 Maintenance Pack 5 (V.1.2.500) MTOSI API Guide for OSS Integration
37
4.3.2.2.1 Input
Request Parameter
Data Type
Description
requestedBatchSize
integer
Maximum number of objects to return.
getAllEquipmentRequest
getAllEquipmentRequ
est
est
Request element. May contain additional
granularity input, or may be empty while
returning every equipment in system.
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.
or equipment holder in which the equipment is
to be found.
4.3.2.2.2 Output
Response Data
Data Type
Description
getAllEquipmentRes
ponse
ponse
getAllEquipmentRe
sponseType
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).
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.
invalidInput: Indicates that the input given to the operation is invalid.
4.3.2.3 getEquipmentIterator
This operation returns Equipment information in batches.
4.3.2.3.1 Input
Request Parameter
Data Type
Description
iteratorReferenceURI
String
Iterator reference URI which must be present to retrieve
next batch of equipment.
Note: This information is set on the request message on
the MTOSI header part.
next batch of equipment.
Note: This information is set on the request message on
the MTOSI header part.
4.3.2.3.2 Output
Response Data
Data Type
Description
batchSequenceEndOf
Reply
Reply
boolean
Indicator of end of batched replies.
iteratorReferenceURI
String
Iterator reference URI which can be used to retrieve the
next batch.
next batch.
getEquipmentIterator
Response
Response
EquipmentOrEquipme
ntHolderListType
ntHolderListType
Holder for containing list of equipment details.
For equipment details, see the equipment data table
above.
For equipment details, see the equipment data table
above.
4.3.2.3.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.
invalidInput: Indicates that the input given to the operation is invalid.
4.3.2.4 getContainedEquipment
This operation retrieves information about a specified contained equipment.