3.5.4.8.1.42 IpamIPAddressByFilterEnumerationParameters

The IpamIPAddressByFilterEnumerationParameters processing is done when the EnumInputParameters contains data of type IpamIPAddressByFilterEnumerationParameters. The ObjectType MUST be EnumerationObjectType.IPAddress. This is used to enumerate all IP addresses that belong to an address family and meet all the filter criteria in IpamIPAddressByFilterEnumerationParameters.filterInfo. IpamIPAddressByFilterEnumerationParameters.filterInfo is a collection of various filter types (specified by ipam:GetIpamIPAddressFilter) and their values.

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

  1. Enumerate all the rows in ADM_IPAddressTable and call GetIPAddressFromTable from ADM_ IPAddressTable by passing the RecordId as Param_AddressSpaceId and IpamIPAddressByFilterEnumerationParameters.AddressFamily as Param_AddressFamily.

  2. For each IPAddress object, check if it satisfies each subcriteria in IpamIPAddressByFilterEnumerationParameters.FilterInfo and add it to EnumOutputData if it does.