3.3.4.48 FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace
The FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace operation is used to retrieve the IpamIPAddress given the specified IP address and the values for the ManagedBy and ManagedByEntity built-in custom field values and an AddressSpace.
-
<wsdl:operation name="FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace"> <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace" message="ipam:IIpamServer_FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace_InputMessage" /> <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpaceResponse" message="ipam:IIpamServer_FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace_OutputMessage" /> </wsdl:operation>
Upon receiving the IIpamServer_FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace_InputMessage request message, the server performs the following processing steps. Upon successful completion of these steps, the server MUST respond with the IIpamServer_FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace_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 FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.addressFamily is InterNetwork, the rest of the processing is done with the IPv4-specific tables. The FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpaceResponse.FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpaceResult will consist of an IpamIPv4Address. Otherwise IPv6-specific tables are used for further processing. The FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpaceResponse.FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpaceResult will consist of an IpamIPv6Address.
If the addressfamily of FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.address is NULL, or FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.managedBy is NULL, or FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.managedByEntity is NULL, an appropriate SOAP fault MUST be returned.
Validate the input FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.address is usable by calling ValidateIPamIPAddress. Else, an appropriate SOAP fault MUST be sent as specified in section 2.2.2.1.
Enumerate the rows in ADM_IPAddressTable where IPAddress is same as FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.address. For each row:
Calculate the ManagedBy value to be the custom field value whose custom field identifier is the same value as ADM_ManagedByCustomFieldId.
Calculate the ManagedByEntity value to be the custom field value whose custom field identifier is the same as the ADM_ManagedByEntityCustomFieldId.
If the FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.addressSpaceId is same as the AddressSpaceRecordId for the row in ADM_IPAddressTable, and FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.managedBy is the same as the ManagedBy computed previously and FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.managedByEntity is the same as the ManagedByValue computed previously, the row has to be added to FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpaceResponse.FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpaceResult. This is done by calling the procedure GetIPAddressFromTable passing RecordId of the row as Param_id input parameter and FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpace.addressFamily as Param_addressfamily parameters. The result returned is added to FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpaceResponse.FetchIpamIPAddressByManagedByAndManagedByEntityAndAddressSpaceResult.