Share via

2.2.4.155 DhcpServer

The DhcpServer complex type specifies the common details of a DHCP server instance.

 <xs:complexType name="DhcpServer">
   <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="AuditLoggingStatus" type="ipam:DhcpAuditLoggingStatus" />
         <xs:element minOccurs="0" name="DiscardDnsRecordOnLeaseDeletionStatus" type="ipam:DhcpDiscardDnsRecordOnLeaseDeletionStatus" />
         <xs:element minOccurs="0" name="DnsNameProtectionStatus" type="ipam:DhcpDnsNameProtectionStatus" />
         <xs:element minOccurs="0" name="DnsRegistrationCredentialDomainName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DnsRegistrationCredentialPassword" nillable="true" type="xsd:base64Binary" />
         <xs:element minOccurs="0" name="DnsRegistrationCredentialUserName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DnsUpdateType" type="ipam:DhcpDnsUpdateType" />
         <xs:element minOccurs="0" name="IsInheritedAccessScope" type="xsd:boolean" />
         <xs:element minOccurs="0" name="NumberOfActiveLeases" type="xsd:double" />
         <xs:element minOccurs="0" name="NumberOfAvailableAddresses" type="xsd:double" />
         <xs:element minOccurs="0" name="NumberOfScopes" type="xsd:int" />
         
         <xs:element minOccurs="0" name="OptionDefinitions" nillable="true" type="ipam:DhcpOptionDefinitionCollection" />
         <xs:element minOccurs="0" name="Options" nillable="true" type="ipam:DhcpOptionCollection" />
         <xs:element minOccurs="0" name="RecordId" type="xsd:long" />
         <xs:element minOccurs="0" name="ServerRoleInfo" nillable="true" type="ipam:ServerRoleDhcp" />
         <xs:element minOccurs="0" name="UserClasses" nillable="true" type="ipam:DhcpUserClassCollection" />
         <xs:element minOccurs="0" name="VendorClasses" nillable="true" type="ipam:DhcpVendorClassCollection" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

AccessScopeId:  This represents the unique identifier in IPAM data store of the access scope associated with this DhcpServer object.

AuditLoggingStatus:  Specifies whether the audit log functionality of the DHCP server is enabled or not.

DiscardDnsRecordOnLeaseDeletionStatus:  Specifies the DNS operation to be performed when the address lease expires and the lease record gets deleted.

DnsNameProtectionStatus:  Specifies the setting of DNS name protection at the DHCP server instance level. See [RFC4701] for information on the name protection.

DnsRegistrationCredentialDomainName:  Specifies the domain name of the user credential to be used for DNS registration on the DHCP server.

DnsRegistrationCredentialPassword: Specifies the password of the user credential to be used for DNS registration on the DHCP server.

DnsRegistrationCredentialUserName:  Specifies the user name of the user credential to be used for DNS registration on the DHCP server.

DnsUpdateType:  Specifies the dynamic DNS registration settings defined on the DHCP server instance.

IsInheritedAccessScope: This is a Boolean that indicates whether this DHCP server has inherited its access scope from its parent DHCP server.

NumberOfActiveLeases:  Specifies the total number of active leases on the DHCP server instance.

NumberOfAvailableAddresses:  Specifies the total number of available addresses on the DHCP server instance.

NumberOfScopes:  Specifies the total number of scopes that are available on the DHCP server instance.

OptionDefinitions:  Specifies the list of DHCP option definition instances defined on the DHCP server instance.

Options:  Specifies the list of DHCP option defined at the server-level.

RecordId:  Specifies the unique identifier for the data in the IPAM data store.

ServerRoleInfo:  Specifies the role-specific information for the DHCP server.

UserClasses:  Specifies the user classes associated with the DHCP server instance.

VendorClasses:  Specifies the vendor classes associated with the DHCP server instance.