Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Page of 631
 
MTOSI Interface Details 
 
 
 
 
 
 
Cisco EPN Manager 2.0.1 MTOSI API Guide for OSS Integration  
 
 
76 
4.12 QosProfileNameRetrieval 
This interface provides operations that retrieve QoS profile names. Can be used to retrieve the QoS profile 
names required for provisioning input. 
4.12.1.1 
getAllQosProfileNames 
This operation retrieves the list of QoS profile names. 
4.12.1.1.1 
Input 
Request Parameter  
Data Type 
Description 
getAllQosProfileNamesRequest 
 
getAllQosProfileNamesRequest 
 
Element representing the request. 
MTOSI request headers batch size 
controls how much data will be 
returned. 
4.12.1.1.2 
Output 
Response Data 
Data Type 
Description 
getAllQosProfileNamesResp
onse 
 
getAllQosProfileNames
Response 
 
The response containing the list of QoS profile 
names. Each contains the elements mentioned 
below. 
qosProfileNameList 
QosProfileListType 
List to hold the QoS profile names. 
qosProfileName 
QosProfileNameType 
This element contains the details given below. 
name (Object Id) 
NamingAttributeType 
List of RDNs containing the MD and QOS_PROFILE. 
discoveredName 
String 
Name of the QoS profile. 
4.12.1.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.12.1.2 
getQosProfileNamesIterator 
This operation retrieves the handle to the Iterator, which can be used to retrieve the list of QoS profile 
names.  
4.12.1.2.1 
Input 
Request Parameter  
Data Type 
Description 
iteratorReferenceURI 
 String 
Iterator reference URI which must be present to 
retrieve next batch of managed elements. 
Note: This information is set on the request 
message on the MTOSI header part. 
getQosProfileNamesIt
eratorRequest 
getQosProfileIteratorReque
stType 
Empty element representing the iterator request. 
4.12.1.2.2 
Output 
Response Data  
Data Type 
Description 
batchSequenceEndOfReply 
boolean 
Indicator of end of batched replies. 
iteratorReferenceURI 
String  
Iterator reference URI which can be used to 
retrieve the next batch. 
getQosProfileNamesIteratorRe
sponse 
 
 
getQosProfileNam
esIteratorResponse
Type 
 
Holder for containing the list of QoS profile names. 
Each QoS profile name details is same as in the 
getAllQosProfileNames operation response.