DHCP_SERVER_CONFIG_INFO_VQ structure (dhcpsapi.h)

The DHCP_SERVER_CONFIG_INFO_VQ structure defines settings for the DHCP server.

Syntax

typedef struct _DHCP_SERVER_CONFIG_INFO_VQ {
  DWORD  APIProtocolSupport;
  LPWSTR DatabaseName;
  LPWSTR DatabasePath;
  LPWSTR BackupPath;
  DWORD  BackupInterval;
  DWORD  DatabaseLoggingFlag;
  DWORD  RestoreFlag;
  DWORD  DatabaseCleanupInterval;
  DWORD  DebugFlag;
  DWORD  dwPingRetries;
  DWORD  cbBootTableString;
  WCHAR  *wszBootTableString;
  BOOL   fAuditLog;
  BOOL   QuarantineOn;
  DWORD  QuarDefFail;
  BOOL   QuarRuntimeStatus;
} DHCP_SERVER_CONFIG_INFO_VQ, *LPDHCP_SERVER_CONFIG_INFO_VQ;

Members

APIProtocolSupport

Integer value that defines the type of RPC protocol used by the DHCP server to register with RPC. Following is the set of supported types, which may be bitwise OR'd to produce valid values.

DatabaseName

Pointer to a null-terminated Unicode string that represents the DHCP server database name that is used by the DHCP server for persistent storage.

DatabasePath

Pointer to a null-terminated Unicode string that contains the absolute path, where the DHCP server database is stored.

BackupPath

Pointer to a null-terminated Unicode string that contains the absolute path for backup storage that is used by the DHCP server for backup.

BackupInterval

Integer value that specifies the interval in minutes between backups of the DHCP server database.

DatabaseLoggingFlag

Integer value that indicates the transaction logging mode of the DHCP server. The value 1 indicates that the transaction log is enabled for the DHCP server, and 0 indicates that the transaction log is disabled for the DHCP server.

RestoreFlag

Integer value used as a BOOL flag. If this setting is TRUE (1), the DHCP service loads the DHCP database from the backup database on DHCP service startup. The default value of this flag is FALSE (0).

DatabaseCleanupInterval

Integer value that specifies the maximum time interval that DOOMED IPv4 DHCP client records are allowed to persist within the DHCP server database.

DebugFlag

Integer flag value that specifies the level of logging done by the DHCP server. The following table defines the set values that can be used. Specifying '0xFFFFFFFF' enables all types of logging.

LOW WORD bitmask (0x0000FFFF) for low-frequency debug output.

HIGH WORD bitmask (0xFFFF0000) for high-frequency debug output, that is, more verbose.

dwPingRetries

Integer value that specifies the number of retries that the DHCP server can make to verify whether a particular address is already in use by any client by issuing a ping before issuing any address to the DHCP client (valid range: 0–5, inclusive).

cbBootTableString

Integer value that contains the size of the BOOT TABLE given to the DHCP client.

wszBootTableString

Pointer to a null-terminated Unicode string that contains the absolute path of the BOOTP TABLE given to the BOOTP client.

fAuditLog

If TRUE, an audit log will be written by the DHCP server; if FALSE, it will not.

QuarantineOn

If TRUE, Quarantine is turned ON on the DHCP server; if FALSE, it is turned OFF.

QuarDefFail

Integer value that determines the default policy for a DHCP NAP server when an NPS server is not reachable. Choices include Quarantine/unrestricted/Drop Request.

QuarRuntimeStatus

If TRUE, NAP is enabled on the DHCP server; if FALSE, it is not.

Requirements