2.2.4.141 DhcpScope
The DhcpScope complex type specifies the details associated with a DHCP scope.
-
<xs:complexType name="DhcpScope"> <xs:complexContent mixed="false"> <xs:extension base="ipam:BaseIpamObject"> <xs:sequence> <xs:element minOccurs="0" name="AccessScopeId" type="xsd:long" /> <xs:element minOccurs="0" name="Description" nillable="true" type="xsd:string" /> <xs:element minOccurs="0" name="DiscardDnsRecordOnLeaseDeletionStatus" type="ipam:DhcpDiscardDnsRecordOnLeaseDeletionStatus" /> <xs:element minOccurs="0" name="DnsNameProtectionStatus" type="ipam:DhcpDnsNameProtectionStatus" /> <xs:element minOccurs="0" name="DnsUpdateType" type="ipam:DhcpDnsUpdateType" /> <xs:element minOccurs="0" name="EndAddress" nillable="true" type="sysnet:IPAddress" /> <xs:element minOccurs="0" name="ExclusionRanges" nillable="true" type="ipam:DhcpExclusionRangeCollection" /> <xs:element minOccurs="0" name="IsInheritedAccessScope" type="xsd:boolean" /> <xs:element minOccurs="0" name="NumberOfActiveLeases" type="xsd:double" /> <xs:element minOccurs="0" name="Options" nillable="true" type="ipam:DhcpOptionCollection" /> <xs:element minOccurs="0" name="ParentDhcpServerRecordId" type="xsd:long" /> <xs:element minOccurs="0" name="PrefixLength" type="xsd:int" /> <xs:element minOccurs="0" name="RecordId" type="xsd:long" /> <xs:element minOccurs="0" name="ScopeId" nillable="true" type="sysnet:IPAddress" /> <xs:element minOccurs="0" name="ScopeName" nillable="true" type="xsd:string" /> <xs:element minOccurs="0" name="StartAddress" nillable="true" type="sysnet:IPAddress" /> <xs:element minOccurs="0" name="Status" type="ipam:DhcpScopeStatus" /> <xs:element minOccurs="0" name="SubnetMask" nillable="true" type="sysnet:IPAddress" /> <xs:element minOccurs="0" name="TotalNumberOfAddressesInScope" type="xsd:double" /> <xs:element minOccurs="0" name="TotalNumberOfExcludedAddressesInScope" type="xsd:double" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>
AccessScopeId: Specifies the unique identifier corresponding to the access scope for this DHCP scope.
Description: The description for the DHCP scope.
DiscardDnsRecordOnLeaseDeletionStatus: Specifies the DNS operation to be performed when the address lease expires, and then the lease record gets deleted.
DnsNameProtectionStatus: Specifies the setting of DNS name protection for the scope. See [RFC4701] for information on the name protection.
DnsUpdateType: Specifies the dynamic DNS registration settings associated with the DHCP scope.
EndAddress: Specifies the end address of the address range specified by the scope.
ExclusionRanges: Specifies the collection of DHCP exclusion ranges associated with the scope.
IsInheritedAccessScope: A Boolean field that specifies whether the access scope for this object is an inherited one.
NumberOfActiveLeases: Specifies the number of active leases associated with the scope.
Options: Specifies the collection DHCP options associated with the scope.
ParentDhcpServerRecordId: Specifies the RecordId of the DHCP server instance against which the scope instance is defined.
PrefixLength: Specifies the prefix length associated with the subnet mask that defines the scope.
RecordId: Specifies the unique identifier for the data in the IPAM data store.
ScopeId: Specifies the subnet ID of the referenced DHCP scope.
ScopeName: Specifies the name of the DHCP scope.
StartAddress: Specifies the start address of the address range specified by the scope.
Status: Specifies whether the scope instance is activated or deactivated.
SubnetMask: Specifies the end IP address for the IP address range configured on the referenced DHCP scope.
TotalNumberOfAddressesInScope: Specifies the total number of addresses in the scope address range. This value MUST NOT be less than 0.
TotalNumberOfExcludedAddressesInScope: Specifies the total number of excluded addresses in the exclusion ranges of the scope. This value MUST NOT be less than 0.