Share via

3.5.4.8.1.38 IpamIPAddressAllForLogicalGroupEnumerationParameters

The IpamIPAddressAllForLogicalGroupEnumerationParameters processing is done when the EnumInputParameters contains data of type IpamIPAddressAllForLogicalGroupEnumerationParameters. The ObjectType MUST be EnumerationObjectType.IPAddress. This is used to enumerate the addresses mapped to a particular logical group specified by IpamIPAddressAllForLogicalGroupEnumerationParameters.LogicalGroupRecordId. The IpamIPAddressAllForLogicalGroupEnumerationParameters.AddressFamily is used to determine the simple table within ADM_IPAddressTable on which the processing has to be 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 steps identify the rows to be returned as a part of the enumeration:

  1. Call the procedure GetObjectIdsForLogicalGroup in ADM_CustomFieldValuesAssociationTable passing the following parameters:

  2. Param_logicalGroup is set to LogicalGroup instance corresponding to the IpamIPAddressAllForLogicalGroupEnumerationParameters.LogicalGroupRecordId that is retrieved by calling the procedure GetLogicalGroupFromTable in ADM_LogicalGroupsTable. This is done so by passing Param_Id as IpamIPAddressAllForLogicalGroupEnumerationParameters.LogicalGroupRecordId. Param_groupType is set to LogicalGroupType.Range and Param_addressFamily is set to IpamIPAddressAllForLogicalGroupEnumerationParameters.AddressFamily.

  3. Param_objectType is set to LogicalGroupType.Range.

  4. Param_addressFamily is set to IpamIPAddressAllForLogicalGroupEnumerationParameters.AddressFamily.

  5. The previously returned Result_ObjectIds comprises a list of address range instances. Get the list of addresses that map to these address ranges by enumerating the rows whose RangeRecordId is the value of the range record identifier returned in Result_ObjectIds.

  6. For each of the address instances, call the procedure GetIPAddressFromTable in ADM_IPAddressTable passing the address instance’s record identifier as Param_Id and IpamIPAddressAllForLogicalGroupEnumerationParameters.AddressFamily as Param_addressFamily. 

  7. Add the returned result to EnumOutputData.