3.1.1.1.3.2.3 GetAllMappingIPAddressesForRange

The following are the input parameters to the GetAllMappingIPAddressesForRange procedure:

Param_Id: This is a 64-bit signed integer that identifies the RecordId for IPRange for which the mapping addresses information is being retrieved.

Param_addressfamily: This is of type AddressFamily and it can be either InterNetwork or InterNetworkV6. The value InterNetwork is used to specify the processing to be done on the IPv4-specific simple tables for any compound table involved during the processing. The value InterNetworkV6 is used to specify the processing to be done on IPv6-specific simple tables for any compound table involved during the processing.

The following is the output parameter from this procedure.

Result_mappingAddresses: This is the collection of address information in the form of IpamIPv4Address or IpamIPv6Address, corresponding to the Param_Id specified in the input parameter. If the Param_addressfamily is InterNetwork, the procedure returns IpamIPv4Address, and if it is InterNetworkV6, the procedure returns IpamIPv6Address.

The following processing steps are performed:

  1. Look up the ADM_IPAddressTable for all the rows with the RangeRecordId value being Param_Id.

  2. If the rows are not found, return NULL. Otherwise initialize Result_mappingAddresses to collection of IpamIPv4Address if the Param_addressfamily is InterNetwork and IpamIPv6Address if Param_addressfamily is InterNetworkV6.

  3. For each row that has been found, call GetIPAddressFromTable procedure of ADM_IPAddressTable passing the following parameters:

    1. RecordId is assigned to Param_Id.

    2. Param_addressfamily is assigned to Param_addressfamily.

  4. Process the output result and add it to the collection Result_mappingAddresses.

  5. Return Result_mappingAddresses as the output of the procedure.