3.3.4.39 GetIPAddressById

This operation is get theIP address, having the specified record identifier from the IPAM data store.

 <wsdl:operation name="GetIPAddressById">
   <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetIPAddressById" message="ipam:IIpamServer_GetIPAddressById_InputMessage" />
   <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetIPAddressByIdResponse" message="ipam:IIpamServer_GetIPAddressById_OutputMessage" />
 </wsdl:operation>

Upon receiving the IIpamServer_GetIPAddressById_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_GetIPAddressById_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.

  1. If the GetIPAddressById.addressFamily is Internet, the rest of the processing is done with the IPv4-specific tables. The GetIPAddressByIdResponse.GetIPAddressByIdResult will consist of an IpamIPv4Address. Otherwise IPv6-specific tables are used for further processing. The GetIPAddressByIdResponse. GetIPAddressByIdResult will consist of an IpamIPv6Address.

  2. If the GetIPAddressById.Id is not NULL and GetIPAddressById.Id is 0, return NULL.

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

  4. Add the returned address information in result to GetIPAddressByIdResponse. GetIPAddressByIdResult.