Технические ссылки для Cisco Cisco Prime Network Registrar 8.1

Скачать
Страница из 316
getAddressPool 
Cisco Prime Network Registrar IPAM 8.1.1 CLI and API Guide 
210 
Gets 
Overview 
This section explains the web services available for retrieving individual objects from 
Cisco Prime Network Registrar IPAM.  These services can be used in conjunction with 
Imports to modify Cisco Prime Network Registrar IPAM objects.  Each of these services 
is available as an operation in the Gets web service.  You can see the complete WSDL at:  
getAddressPool 
This operation retrieves information about an address pool from Cisco Prime Network 
Registrar IPAM.   
This call can be used in conjunction with the 
ImportAddressPool
 call to modify an 
existing address pool.  Use this call to retrieve an address pool based on its starting 
address.  Modify the returned structure as needed and pass the modified structure to 
ImportAddressPool
.  
ImportAddressPool
 will perform an update instead of a 
create due to the presence of an ID element in the address pool structure. 
Request and Response Messages 
Below is the portion of 
Gets.wsdl that describes the 
getAddressPool
 request and 
response messages. 
<wsdl:message name="getAddressPoolResponse"> 
   <wsdl:part name="getAddressPoolReturn" type="tns2:WSAddrpool"/> 
</wsdl:message> 
<wsdl:message name="getAddressPoolRequest"> 
   <wsdl:part name="startAddress" type="soapenc:string"/> 
   <wsdl:part name="container" type="soapenc:string"/> 
</wsdl:message> 
Response 
If the address pool is found, a 
WSAddrpool
 structure is filled in with its information.  
This structure is also used by the 
ImportAddressPool
 API call. 
Request 
There are two parameters in the request. 
Parameter 
Description 
Required 
startAddr 
The starting address of the Address Pool 
Yes 
Container 
The container holding the block in which the address pool 
resides. 
Only if startAddr is not 
unique due to 
overlapping blocks. 
Return Codes 
If the address pool is not found, the call will fail with an error code of -117.