Cisco Cisco Prime Network Registrar 8.1 Technical References

Page of 316
GlobalNetServiceSync 
Cisco Prime Network Registrar IPAM 8.1.1 CLI and API Guide 
230 
GlobalNetServiceSync 
Overview 
The 
globalNetServiceSync
 API enables the web service client to issue an immediate 
Global Synchronization task for all network services in Cisco Prime Network Registrar 
IPAM that are flagged for inclusion in the Global Sync process. 
Request and Response Messages 
Below is the portion of 
TaskInvocation.wsdl that describes the 
globalNetServiceSync
 
request and response messages. 
<wsdl:message name="globalNetServiceSyncResponse"> 
  <wsdl:part name="globalNetServiceSyncReturn" type="xsd:int" />  
</wsdl:message 
  <wsdl:message name="globalNetServicetSyncRequest"> 
  <wsdl:part name="adminId" type="soapenc:string" />  
  <wsdl:part name="password" type="soapenc:string" />  
</wsdl:message> 
Response 
If the task is scheduled successfully, the positive integer returned by the web service will 
correspond to the task number. That task number can then be passed to the 
taskStatus
 service to obtain the status of that task. If the task is not scheduled 
successfully, the negative integer returned in the response contains a code as described in 
the chapter introduction. 
Request 
The parts passed as input from the client to the web service are described in the next 
section. 
Parameters 
Below is the portion of 
TaskInvocation.wsdl that describes the parameter structure passed to 
globalNetServiceSync
 . The individual parameters are described below. 
<wsdl:operation name="globalNetServiceSync" parameterOrder="adminId password"> 
  <wsdl:input message="impl:globalNetServiceSyncRequest"  
              name="globalNetServiceSyncRequest" />  
  <wsdl:output message="impl:globalNetServiceSyncResponse"  
               name="globalNetServiceSyncResponse" />  
  </wsdl:operation> 
Part name 
Description and accepted values 
Required 
adminId 
Cisco Prime Network Registrar IPAM administrator’s 
user id 
Yes 
password 
Cisco Prime Network Registrar IPAM administrator’s 
password 
Yes