3.1.1.1 Global Variables

The following list describes top-level ADM data elements. Each of these elements is a complex data entity, which is further described in a subsequent subsection.

DHCPv4ScopesList (Public): Represents the list of scopes hosted by the DHCP server for IPv4 subnets. Each list entry is an instance of the abstract data type DHCPv4Scope specified in section 3.1.1.2. As a part of protocol initialization, DHCPv4ScopesList ADM element is initialized to an empty list when there are no DHCPv4 scopes defined. Each scope is uniquely identified using the SubnetAddress member of the ScopeInfo structure (section 3.1.1.2). When SubnetAddress is passed as a parameter to any method, it indicates that the method is processed on the scope with the specified SubnetAddress. This variable is stored in memory as well as in persistent store.

DHCPv4SuperScopesList (Public): Represents the list of superscopes hosted by the DHCP Server. Each list entry is an instance of the abstract data type DHCPv4SuperScope specified in section 3.1.1.3. As part of protocol initialization, DHCPv4SuperScopesList ADM element  is initialized to an empty list when there are no DHCPv4 superscopes defined. Each superscope is uniquely identified using SuperScopeName. When SuperScopeName is passed as a parameter to any method, it indicates that the method is processed on the superscope with the specified SuperScopeName. This variable is stored in memory as well as in persistent store.

DHCPv4MScopesList: Represents the list of DHCPv4 multicast scopes hosted by the DHCP Server. Each list entry is an instance of the abstract data type represented by the DHCPv4MScope ADM element specified in section 3.1.1.13. As a part of protocol initialization, the DHCPv4MScopesList ADM element is initialized to an empty list when there are no DHCPv4 multicast scopes defined. Each multicast scope is uniquely identified using the MScopeId member of the MScopeInfo ADM element specified in section 3.1.1.13. This variable is stored in memory as well as in persistent store.

DHCPv4ClassDefList (Public): Represents the list of DHCPv4 user classes or vendor classes configured on the DHCP Server. Each list entry is an instance of the abstract data type DHCPv4ClassDef. This variable is stored in memory as well as in persistent store.

DHCPv4OptionDefList: Represents the list of DHCPv4 options defined on the DHCP Server. Each list entry is an instance of the abstract data type DHCPv4OptionDef. This variable is stored in memory as well as in persistent store.

DHCPv4ServerOptValueList (Public): Represents the list of DHCPv4 option values configured on the DHCP Server at server level. Each list entry is an instance of the abstract data type DHCPv4OptionValue, as specified in section 3.1.1.11. This variable is stored in memory as well as in persistent store.

DHCPv4FilterStatus (Public): Represents the status of the allow and deny filters configured on the DHCP Server. The DHCPv4FilterStatus ADM element is of type DHCP_FILTER_GLOBAL_INFO structure, specified in section 2.2.1.2.91. This variable is stored in memory as well as in persistent store.

DHCPv4FiltersList (Public): Represents the list of link layer address/patterns configured in the allow or deny filter list. Each list entry is an instance of the abstract data type DHCPv4Filter, as specified in section 3.1.1.30. This variable is stored in memory as well as in persistent store.

DHCPv6ScopeList (Public): Represents the list of DHCPv6 scopes in the DHCPv6 Server, each represented by the DHCPv6Scope ADM element specified in section 3.1.1.14. This object is initialized to an empty list when the DHCPv6 Server starts for the first time without any scopes configured. This variable is stored in memory as well as in persistent store.

DHCPv6ClassDefList (Public): Represents the list of user classes and vendor classes that are configured on the DHCPv6 Server, each represented by the DHCPv6ClassDef ADM element specified in section 3.1.1.19. The configured user classes and vendor classes are used to create specific user class option values. This variable is stored in memory as well as in persistent store.

DHCPv6ClassedOptionDefList: Represents the set of all option definitions on the DHCPv6 Server. It consists of a list of DHCPv6ClassedOptionDef ADM elements objects specified in section 3.1.1.20. Option definitions are used to enable options and assign values to them. This variable is stored in memory as well as in persistent store.

DHCPv6ServerClassedOptValueList (Public): Represents the set of all option values configured at the server level. It consists of a list of DHCPv6ClassedOptValue ADM element objects specified in section 3.1.1.17. The option value objects represent the options that are returned to clients in DHCP packets along with values required by the client. This variable is stored in memory as well as in persistent store.

DHCPv4ServerMibInfo (Public): Represents the DHCPv4 Server statistics set. These statistics are measured from the time the DHCP service starts. The DHCPv4ServerMibInfo ADM element corresponds to the data type DHCP_MIB_INFO_VQ (section 2.2.1.2.50) structure, except that there are no members in it corresponding to the Scopes and ScopeInfo members of DHCP_MIB_INFO_VQ structure. It can be read using the APIs R_DhcpGetMibInfo and R_DhcpGetMibInfoV5 methods. This variable is stored only in memory, not in persistent store.

DHCPv4ServerMcastMibInfo: Represents the set of MADCAP server statistics measured from the time the DHCP service starts. DHCPv4ServerMcastMibInfo is of type DHCP_MCAST_MIB_INFO structure, specified in section 2.2.1.2.52. The Scopes and ScopeInfo members of the DHCP_MIB_INFO_VQ (section 2.2.1.2.50) structure are not included. This variable is stored only in memory, not in persistent store.

DHCPv6ServerMibInfo (Public): Represents the set of DHCPv6 Server statistics. These statistics are measured from the time the DHCP service starts. The DHCPv6ServerMibInfo ADM element corresponds to the data type DHCP_MIB_INFO_V6 (section 2.2.1.2.68) structure, except that there are no members in it corresponding to the Scopes and ScopeInfo members of DHCP_MIB_INFO_V6 structure. It can be read using the API R_DhcpGetMibInfoV6 method. This variable is stored only in memory, not in persistent store.

DHCPv4ServerConfigInfo (Public): Represents the DHCP Server configuration information. It corresponds to the data type DHCP_SERVER_CONFIG_INFO_VQ (section 2.2.1.2.55) structure. The DHCPv4ServerConfigInfo ADM element can be set by using the API methods R_DhcpServerSetConfig, R_DhcpServerSetConfigV4, and R_DhcpServerSetConfigVQ. It can be read by using the API methods R_DhcpServerGetConfig, R_DhcpServerGetConfigV4, and R_DhcpServerGetConfigVQ. This variable is stored in memory as well as in persistent store.

DHCPv6ServerAuditLogState: Stores a value that specifies whether the audit log is enabled or disabled for the DHCPv6 Server. The DHCPv6ServerAuditLogState ADM element corresponds to the BOOL data type. It can be set by using the API R_DhcpServerSetConfigV6 method and read using the API R_DhcpServerGetConfigV6 method. This variable is stored in memory as well as in persistent store.

DHCPv4AuditLogParams: Represents the audit log properties set. The DHCPv4AuditLogParams ADM element can be set using the API R_DhcpAuditLogSetParams method and read using the API R_DhcpAuditLogGetParams method. This data element is further described in section 3.1.1.25. This variable is stored in memory as well as in persistent store.

DHCPv4ServerAttributes: Represents the DHCP Server attributes set. The DHCPv4ServerAttributes ADM element can be read using the API methods R_DhcpServerQueryAttributes and R_DhcpServerQueryAttribute. This data element is further described in section 3.1.1.26. This variable is stored only in memory, not in persistent store.

DHCPServerDnsRegCredentials: Represents the credentials required for the DHCP Server to do dynamic DNS updates. The DHCPServerDnsRegCredentials ADM element can be queried using the API R_DhcpQueryDnsRegCredentials method and can be set using the API methods R_DhcpSetDnsRegCredentials and R_DhcpSetDnsRegCredentialsV5. This data element is further described in section 3.1.1.27. This variable is stored in memory as well as in persistent store.

DHCPServerRestorePath: Stores the path from which to retrieve data for the ADM elements. This path is used when the DHCP Server is restarted after calling an API to restore the ADM elements. The DHCPServerRestorePath ADM element corresponds to the LPWSTR data type. ADM elements can be restored from a specific location by using the API R_DhcpRestoreDatabase method. This variable is stored in memory as well as in persistent store.

DHCPServerSpecificStrings: Stores server-specific strings. These strings cannot be modified. DHCPServerSpecificStrings ADM element corresponds to the data type DHCP_SERVER_SPECIFIC_STRINGS (section 2.2.1.2.77) structure and can be retrieved using the API R_DhcpGetServerSpecificStrings method. This variable is stored only in memory and not in persistent store.

DHCPv4ServerBindingInfoList: Stores the binding information of all the static interfaces on the DHCPv4 Server. The DHCPv4ServerBindingInfoList ADM element consists of a list of DHCPv4ServerBindingInfo ADM element objects and is updated whenever a static interface is modified or created. The list can be set using the API R_DhcpSetServerBindingInfo method, and can be read using the API R_DhcpGetServerBindingInfo method. This variable is stored in memory as well as in persistent store.

DHCPv6ServerBindingInfoList: Stores the binding information of all the static interfaces on the DHCPv6 Server. The DHCPv6ServerBindingInfoList ADM element consists of a list of DHCPv6ServerBindingInfo ADM element objects and is updated whenever a static interface is modified or created. The list can be set using the API R_DhcpSetServerBindingInfoV6 method, and can be read using the API R_DhcpGetServerBindingInfoV6 method. This variable is stored in memory as well as in persistent store.

ClientIdentitySids[]: An array of RPC SIDs ([MS-DTYP] section 2.4.2.3) for the DHCP client, obtained from the underlying RPC transport ([MS-RPCE] section 3.3.3.4.3). This variable is stored only in memory, not in persistent store.

DHCPUsersSid: The SID of the DHCP Users group (section 3.5.2). The DHCPUsersSid ADM element corresponds to data type RPC_SID structure. This variable is stored in memory as well as in persistent store.

DHCPAdministratorsSid: The SID of the DHCP Administrators group (section 3.5.3). The DHCPAdministratorsSid ADM element corresponds to datatype RPC_SID structure. This variable is stored in memory as well as in persistent store.

DHCPv4FailoverRelationshipList: Represents the list of failover relationships configured on the DHCPv4 Server. Each list entry is an instance of the DHCPv4FailoverRelationship ADM element structure specified in section 3.1.1.33. As a part of protocol initialization, the DHCPv4FailoverRelationshipList ADM element is initialized to an empty list when there are no DHCPv4 failover relationships defined. Each DHCPv4 failover relationship is uniquely identified using the relationshipName member of the DHCPv4FailoverRelationship ADM element structure (section 3.1.1.33). This variable is stored in memory and in persistent storage.

DHCPv4FailoverStatisticsList: Represents the list of DHCPv4 Server failover statistics for all the scopes that are part of the failover relationship. Each list entry is an instance of the DHCPv4FailoverStatistics ADM element specified in section 3.1.1.34. As a part of protocol initialization, the DHCPv4FailoverStatisticsList ADM element is initialized to an empty list. Each DHCPv4FailoverStatisticsList is uniquely identified using the scopeId member of the DHCPv4FailoverStatisticsList ADM element structure specified in section 3.1.1.34. This variable is stored only in memory and not in persistent storage.

DHCPv4ServerPolicyList (Public): Represents the list of server level policies configured on the DHCPv4 Server. Each list entry is an instance of the DHCPv4Policy ADM element specified in section 3.1.1.35. This variable is stored in memory and in persistent storage.

DHCPv4ServerPolicyEnforcement (Public): Stores whether enforcement of policies is enabled or disabled on the DHCPv4 server. The DHCPv4ServerPolicyEnforcement ADM element corresponds to the BOOL data type. It can be set by using the method R_Dhcpv4SetPolicyEnforcement (section 3.2.4.108) and read using the method R_DhcpV4QueryPolicyEnforcement (section 3.2.4.107)). This variable is stored in memory and in persistent storage.

DHCPv4ServerPolicyOptionValuesList: Stores the list of DHCPv4PolicyOptionValue ADM elements (section 3.1.1.36) set at the server. This variable is stored in memory and in persistent storage.

DHCPV6ServerStatelessSettings: Represents configuration attributes for the DHCPv6 stateless client inventory and corresponds to the data type DHCPV6_STATELESS_PARAMS (section 2.2.1.2.112). The DHCPv6ServerStatelessSettings ADM element can be stored and retrieved using the methods R_DhcpV6SetStatelessStoreParams (section 3.2.4.117) and R_DhcpV6GetStatelessStoreParams (section 3.2.4.118). This variable is stored in memory and in the persistent store.

DHCPv6ServerStatelessStatistics: Represents the DHCPv6 server stateless statistics and corresponds to the data type DHCPV6_STATELESS_STATS (section 2.2.1.2.114). It can be retrieved using the R_DhcpV6GetStatelessStatistics (section 3.2.4.119) method. This variable is stored only in memory.