3.1.1.2 Per DHCPv4Scope (Public)

  • Article

The DHCPv4Scope ADM element represents information and associated properties for an IPv4 scope. This element is initialized when a scope is created using the APIs R_DhcpCreateSubnet and R_DhcpCreateSubnetVQ methods. If DHCPv4Scope is deleted using the API R_DhcpDeleteSubnet method, the contained elements of the DHCPv4Scope described below are also deleted.

The following are the elements of a DHCPv4Scope ADM element.

DHCPv4Scope.ScopeInfo: This field holds the IPv4 subnet information for the DHCPv4 scope. ScopeInfo is of type DHCP_SUBNET_INFO_VQ (section 2.2.1.2.45). This variable is stored in memory as well as in persistent store.

DHCPv4Scope.SuperScopeId: This field is a DWORD specifying the unique ID of the superscope, which contains this DHCPv4 scope. This variable is stored in memory as well as in persistent store.

DHCPv4Scope.DelayOffer: This field is a USHORT containing the time delay, in milliseconds, for offering an IPv4 address to the client from the DHCPv4 scope. This variable is stored in memory as well as in persistent store.

DHCPv4Scope.DHCPv4IpRangesList: This field is a list of IPv4 ranges serviced by the DHCPv4 scope. Each list entry is an instance of the abstract data type DHCPv4IpRange. This variable is stored in memory as well as in persistent store.

DHCPv4Scope.DHCPv4ExclusionRangesList: This field is a list of IPv4 exclusion ranges for the DHCPv4 scope. Each list entry is an instance of the abstract data type DHCPv4ExclusionRange. This variable is stored in memory as well as in persistent store.

DHCPv4Scope.DHCPv4ReservationsList: This field is a list of reserved IPv4 addresses for the DHCPv4 scope. Each list entry is an instance of the abstract data type DHCPv4Reservation (section 3.1.1.6). This variable is stored in memory as well as in persistent store.

DHCPv4Scope.DHCPv4ClientsList: This field is a list of IPv4 clients serviced by the DHCPv4 scope. Each list entry is an instance of the abstract data type DHCPv4Client. To limit memory use, this variable is stored only in persistent storage, not in memory.

DHCPv4Scope.DHCPv4ScopeOptValuesList: This field is a list of option values configured for the DHCPv4 scope. Each list entry is an instance of the abstract data type DHCPv4OptionValue. This variable is stored in memory as well as in persistent store.

DHCPv4Scope.IsFailover: This field is of type BOOL and indicates whether the scope is part of any failover relationship. It is set to FALSE if the scope is not part of a failover relationship, otherwise, it is set to TRUE when the scope is part of a failover relationship. This field is set to TRUE by the R_DhcpV4FailoverCreateRelationship method specified in section 3.2.4.90 and the R_DhcpV4FailoverAddScopeToRelationship method specified in section 3.2.4.95. This variable is stored in memory and in persistent storage.

DHCPv4Scope.DHCPv4ScopePolicyList: A list of scope level policies configured in the DHCPv4Scope ADM element. 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.

DHCPv4Scope.DHCPv4ScopePolicyEnforcement: Stores whether enforcement of policies is enabled or disabled for the DHCPv4Scope. The DHCPv4ServerPolicyEnforcement ADM element specified in section 3.1.1.1 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.

DHCPv4Scope.DHCPv4ScopePolicyOptionValuesList: Stores the set of DHCPv4PolicyOptionValue ADM elements specified in section 3.1.1.36 that are configured at the scope. This variable is stored in memory and in persistent storage.