3.5.4.8.1.44 IpamIPAddressByRangeIdEnumerationParameters

The IpamIPAddressByRangeIdEnumerationParameters processing is done when the EnumInputParameters contains data of type IpamIPAddressByRangeIdEnumerationParameters. The ObjectType MUST be EnumerationObjectType.IPAddress. This is used to enumerate addresses mapped to the specified address range given by IpamIPAddressByRangeIdEnumerationParameters.RangeId. The IpamIPAddressByRangeIdEnumerationParameters.AddressFamily is used to determine the simple table within ADM_IPAddressTable on which the processing is done. If the AddressFamily is InterNetwork, the EnumOutputData is a collection of IpamIPv4Address and if it is InterNetworkV6, the EnumOutputData is a collection of IpamIPv6Address.

The following processing steps identify the rows to be returned as a part of the enumeration:

  1. If IpamIPAddressByRangeIdEnumerationParameters.RangeId is not specified or NULL or 0, an appropriate SOAP fault MUST be generated.

  2. Enumerate the rows in ADM_IPAddressTable that have RangeRecordId equal to IpamIPAddressByRangeIdEnumerationParameters.RangeId as follows:

  3. For each row that meets the previous condition, call the procedure GetIPAddressFromTable passing the following parameters:

  4. RecordId as Param_Id.

  5. IpamIPAddressByRangeIdEnumerationParameters.AddressFamily as Param_addressfamily

  6. Add result to EnumOutputData.