3.3.4.40 GetIPAddressesByIds

This operation is used to retrieve the specified collection of IP address objects from the IPAM data store.

 <wsdl:operation name="GetIPAddressesByIds">
   <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetIPAddressesByIds" message="ipam:IIpamServer_GetIPAddressesByIds_InputMessage" />
   <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetIPAddressesByIdsResponse" message="ipam:IIpamServer_GetIPAddressesByIds_OutputMessage" />
 </wsdl:operation>

Upon receiving the IIpamServer_GetIPAddressesByIds_InputMessage request message, the server performs the following processing steps. Upon successful completion of the steps specified below, the server MUST respond with the IIpamServer_GetIPAddressesByIds_OutputMessage message. In the event of a failure, an appropriate SOAP fault MUST be sent to the client as specified in section 2.2.2.1.

If the GetIPAddressesByIds.addressFamily is Internet, the rest of the processing is done with the IPv4-specific tables. The GetIPAddressesByIdsResponse. GetIPAddressesByIdsResult will consist of a collection of IpamIPv4Address. Otherwise IPv6-specific tables are used for further processing. The GetIPAddressesByIdsResponse.GetIPAddressesByIdsResult will consist of a collection of IpamIPv6Address.

If GetIPAddressesByIds.Ids is NULL, an appropriate SOAP fault MUST be returned.

If number of entries in GetIPAddressesByIds.Ids is 0, then return NULL.

Initialize the GetIPAddressesByIdsResponse.GetIPAddressesByIdsResult to an empty collection.

For each record identifier recordId in the GetIPAddressesByIds.ids,

Get the IpamIPAddress corresponding to the recordId by calling the GetIPAddressFromTable procedure of the ADM_IPAddressTable passing the recordId as Param_id input parameter and GetIPAddressesByIds.addressFamily as the Param_addressfamily input parameter

If the result address is obtained, add it to the GetIPAddressesByIdsResponse.GetIPAddressesByIdsResult collection.