3.1.1.1.13.2.6 GetScopesForSuperscope

The GetScopesForSuperscope procedure can only be applied on IPv4 DhcpScope table. This procedure retrieves all the IPv4 DHCP scopes that are assigned to a specific DHCP superscope.

The following input parameter is used.

Param_superscopeId: A 64-bit signed integer specifying the record identifier of the DhcpSuperscopeV4 instance for which the mapping scopes are being requested.

The following is the output parameter from this procedure.

Result_Scopes: A collection of type DhcpScopeV4.

The following steps are performed against the IPAM data store:

  1. Enumerate the rows in IPv4 table of ADM_DHCPScopesTable where SuperscopeId is equal to Param_superscopeId.

  2. Initialize Result_Scopes.

  3. For each row that meets the criteria in step 1, perform the following steps:

    1. Create an instance of DhcpScopeV4 with the following assignments:

      1. Set DhcpScopeV4.RecordId to RecordId.

      2. Set DhcpScopeV4.ParentDhcpServerRecordId to DHCPServerRecordId.

    2. Copy ScopeDetails of the row to DhcpScopeV4.

    3. Call the procedure GetDhcpOptions of ADM_DhcpOptionsTable with the following parameters: 

      1. Param_addressfamily is set to InterNetwork.

      2. Param_ScopeRecordId is set to DhcpScopeV4.RecordId.

      3. Param_serverRecordId is set to DhcpScopeV4.ParentDhcpServerRecordId.

  4. Assign the Result_optionCollection to DhcpScopeV4.Options.

  5. Add the DhcpScopeV4 instance to Result_Scopes collection.

  6. Return Result_Scopes as the output of the procedure.