Cisco Cisco Prime Central 1.4 Developer's Guide

Page of 203
1.  
a.  
b.  
2.  
a.  
b.  
MPLS VPN Resource Inventory
Prime Central supports the following MPLS VPN Resource Inventory APIs, which are based on the MTOSI 2.0 subnetwork connection
retrieval package. Extensions are introduced to support Cisco Prime implementations. For detailed definitions of the APIs and their
s:
corresponding data types, see the following file
ManagedResourceInventory/ConnectionRetrieval/ConnectionRetrieval.wsdl
ManagedResourceInventory/ConnectionRetrievalMessage.xsd
ManageResourceInventory/xsd/ResourceInventoryRetrievalMessages.xsd
NetworkResourceFulfillment/IIS/xsd/ResourceInventoryLayout.xsd
NetworkResourcesBasic/IIS/xsd/Cisco_MPLS_VPN_LayeredParam.xsd
SOAP Endpoints:
https://<server IP>:<port #>/prime/inventory/ResourceInventoryRetrieval_RPC?wsdl
server IP - Prime Central server IP
port # - configurable, ex 9110
https://<server IP:<port #>/prime/inventory/ConnectionRetrievalRPC?wsdl
server IP - Prime Central server IP
port - configurable, ex 9110
The following table lists the MPLS VPN retrieval APIs.
Object
 
Type
API                                                          
Function 
VPN
names
operation:
 
 
input:
getInventoryRequest
 
 
output: getInventoryResponse
 
fault: get
InventoryException
getInventoryRequest - 
MD=Cisco_PRIME 
MLSN=Cisco_PRIME_Network 
IncludedObject.objectType=SNC 
IncludedObject.granularityType=NAME 
Defined by soap endpoint 1
Retrieves a list of subnetwork connection names. When this operation succeeds, it
returns VPN names under the MD=Cisco_PRIME Domain.
VPN -
connection
 
operation:
 
input:
getSubnetworkConnection
 
Request
output:getSubnetworkConnection
Response
 
fault: get
SubnetworkConnection
Exception
getSubnetworkConnection Request - 
MD=Cisco_PRIME 
MLSN=Cisco_PRIME_Network 
IncludedObject.objectType=SNC 
IncludedObject.granularityType=NAME 
Defined by soap endpoint 2
Retrieves a list of subnetwork connection entities, CTP entities, and virtual route
references. When this operation succeeds, it returns a list of VPN instances, VPN
parameters, CTPs, CTP parameters, and route references.
VRF -
route 
operation:
 
 
input:
getRouteRequest
 
 
output: getRouteResponse
fault: get
RouteException
getRoute Request - 
MD=Cisco_PRIME 
MLSN=Cisco_PRIME_Network 
IncludedObject.objectType=SNC 
IncludedObject.granularityType=FULL 
Defined by soap endpoint 2
Retrieves the connection associated routes and CTP references. When this operation
succeeds, it returns VRF instances, VRF parameters, and CTP references.