Share via


2.2.4.142 LogicalGroupsEnumerationParameters

The LogicalGroupsEnumerationParameters complex type specifies the criteria for enumerating the logical groups from the IPAM data store.

 <xs:complexType name="LogicalGroupsEnumerationParameters">
   <xs:complexContent mixed="false">
     <xs:extension base="ipam:EnumerationParametersBase">
       <xs:sequence>
         <xs:element minOccurs="0" name="AddressFamily" type="syssock:AddressFamily" />
         <xs:element minOccurs="0" name="LogicalGroupName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="LogicalGroupType" type="ipam:LogicalGroupType" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

AddressFamily: This specifies the address family of the data that needs to be enumerated by the logical group. Based on this, the LogicalGroup enumerated for the address family Internet will be  ActiveServerV4LogicalGroup, IpamIPv4AddressLogicalGroup, or IPv4RangeLogicalGroup, based on the logical group type. Similarly, the LogicalGroup enumerated for the address family InternetV6 will be ActiveServerV6LogicalGroup, IpamIPv6AddressLogicalGroup, or IPv6RangeLogicalGroup based on the logical group type.

LogicalGroupName: This specifies the logical group name if a specific logical group name has to be enumerated.

LogicalGroupType: This specifies the type of the logical group that needs to be enumerated.