Share via

3.2.4.67 R_DhcpServerGetConfigV6 (Opnum 66)

  • Article

The R_DhcpServerGetConfigV6 method retrieves the configuration information about the DHCPv6 server.

 DWORD R_DhcpServerGetConfigV6(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in, ref] LPDHCP_OPTION_SCOPE_INFO6 ScopeInfo,
   [out] LPDHCP_SERVER_CONFIG_INFO_V6* ConfigInfo
 );

ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.

ScopeInfo: This is a pointer of type DHCP_OPTION_SCOPE_INFO6 (section 2.2.1.2.30) that is used to identify the scope whose configuration information is to be retrieved.

ConfigInfo: This is a pointer of type LPDHCP_SERVER_CONFIG_INFO_V6 that points to a location that contains the configuration information.

Return Values: A 32-bit unsigned integer value that indicates return status. A return value ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully, else it contains a Win32 error code, as specified in [MS-ERREF]. This error code value can correspond to a DHCP-specific failure, which takes a value between 20000 and 20099, or any generic failure.

Return value/code

Description

0x00000000

ERROR_SUCCESS

The call was successful.

The opnum field value for this method is 66.

When processing this call, the DHCP server MUST do the following:

  • Validate if this method is authorized for read access per section 3.5.4. If not, return the error ERROR_ACCESS_DENIED.

  • Retrieve the DHCPv6OptionValue objects (corresponding to default user and vendor class) with DHCPv6OptionValue.OptionId having value as described in the table shown. Always return ERROR_SUCCESS from this method.

  • Retrieve the DHCPv6OptionValue.OptionData.Elements.Element object depending on DHCPv6OptionValue.OptionData.Elements.ObjectType and fill it in the adequate field of ConfigInfo (see section 2.2.1.2.62 for details of the fields). Valid values are in the following table.

    Field set as option

    Value returned

    0x00000001

    Set_UnicastFlag

    Value set in UNICAST option (0x20000). In case of error the value returned is FALSE.

    0x00000002

    Set_RapidCommitFlag

    Value set in RapidCommit option (0x20001). In case of error the value returned is FALSE.

    0x00000004

    Set_PreferredLifetime

    Value set in PREFERREDLIFETIME option (0x20002). In case of error the value returned is 8 days.

    0x00000008

    Set_ValidLifetime

    Value set in VALIDLIFETIME option (0x20003). In case of error the value returned is 12 days.

    0x00000010

    Set_T1

    Value set in T1 option (0x20004). In case of error while retrieving the data from the database, the value returned is 4 days.

    0x00000020

    Set_T2

    Value set in T2 option (0x20005). In case of error while retrieving the data from the database, the value returned is 6.4 days.

    0x00000040

    Set_PreferredLifetimeIATA

    Value set in PREFERREDLIFETIME_IATA option (0x20006). In case of error while retrieving the data from the database, the value returned is 1 day.

    0x00000080

    Set_ValidLifetimeIATA

    Value set in VALIDLIFETIME_IATA option (0x20007). In case of error while retrieving the data from the database, the value returned is 3 days.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].