3.3.4.84 GetLogicalGroupById

The GetLogicalGroupById operation can be used to query a logical group based on its RecordId.

 <wsdl:operation name="GetLogicalGroupById">
   <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetLogicalGroupById" message="ipam:IIpamServer_GetLogicalGroupById_InputMessage" />
   <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetLogicalGroupByIdResponse" message="ipam:IIpamServer_GetLogicalGroupById_OutputMessage" />
 </wsdl:operation>

Upon receiving the IIpamServer_GetLogicalGroupById_InputMessage request message, the server performs the following processing steps. Upon successful completion of the steps specified following, the server MUST respond with the IIpamServer_GetLogicalGroupById_OutputMessage message. In the event of a failure, an appropriate SOAP fault MUST be sent to the client as specified in section 2.2.2.1:

  1. If GetLogicalGroupById.groupType is LogicalGroupType.Range:

  2. If GetLogicalGroupById.addressFamily is InterNetwork, initialize GetLogicalGroupByIdResponse.GetLogicalGroupByIdResult to IPv4RangeLogicalGroup.

  3. If GetLogicalGroupById.addressFamily is InterNetworkV6, initialize GetLogicalGroupByIdResponse.GetLogicalGroupByIdResult to IPv6RangeLogicalGroup.

  4. If GetLogicalGroupById.groupType is LogicalGroupType.IPAddress:

  5. If GetLogicalGroupById.addressFamily is InterNetwork, initialize GetLogicalGroupByIdResponse.GetLogicalGroupByIdResult to IpamIPv4AddressLogicalGroup.

  6. If GetLogicalGroupById.addressFamily is InterNetworkV6, initialize GetLogicalGroupByIdResponse.GetLogicalGroupByIdResult to IpamIPv6AddressLogicalGroup.

  7. If GetLogicalGroupById.groupType is LogicalGroupType.ManagedServer:

  8. If GetLogicalGroupById.addressFamily is InterNetwork, initialize GetLogicalGroupByIdResponse.GetLogicalGroupByIdResult to ActiveServerV4LogicalGroup.

  9. If GetLogicalGroupById.addressFamily is InterNetworkV6, initialize GetLogicalGroupByIdResponse.GetLogicalGroupByIdResult to ActiveServerV6LogicalGroup

  10. If GetLogicalGroupById.groupType is LogicalGroupType.Subnet:

  11. If GetLogicalGroupById.addressFamily is InterNetwork, initialize GetLogicalGroupByIdResponse.GetLogicalGroupByIdResult to IPv4SubnetLogicalGroup.

  12. If GetLogicalGroupById.addressFamily is InterNetworkV6, initialize GetLogicalGroupByIdResponse.GetLogicalGroupByIdResult to IPv6SubnetLogicalGroup.

  13. Call the procedure GetLogicalGroupFromTable with the following input parameters:

    1. Param_Id is assigned the value of GetLogicalGroupById.id.

    2. Param_addressFamily is assigned the value of GetLogicalGroupById.addressFamily.

    3. Param_groupType is assigned the value of GetLogicalGroupById.addressFamily.

  14. Copy the Result_logicalGroup into GetLogicalGroupByIdResponse.GetLogicalGroupByIdResult.