3.5.4.7.1.25 IpamIPAddressRootAddressesEnumerationParameters

This is the processing done when the EnumInputParameters contains data of type IpamIPAddressRootAddressesEnumerationParameters. The ObjectType MUST be EnumerationObjectType.IPAddress. This is used to enumerate all the addresses specific to the address family and also optionally belonging to a specific AddressCategory in the IPAM data store. The IpamIPAddressRootAddressesEnumerationParameters.AddressFamily is used to determine the simple table within the ADM_IPAddressTable on which the processing has to be done. If the AddressFamily is Internet, the EnumOutputData will be a collection of IpamIPv4Address and if it is InternetV6, the EnumOutputData will be a collection of IpamIPv6Address.

The following are the steps involved in identifying the rows to be returned as a part of the enumeration:

  1. Enumerate the rows in ADM_IPAddressTable. If IpamIPAddressRootAddressesEnumerationParameters.AddressCategory is specified enumerate only those addresses for which AddressDetails.AddressCategory is equal to IpamIPAddressRootAddressesEnumerationParameters.AddressCategory.

    1. For each of the rows that meets the above condition, call the procedure GetIPAddressFromTable passing the RecordId as Param_Id and IpamIPAddressByRangeIdEnumerationParameters.AddressFamily as Param_addressfamily. Add result to EnumOutputData.