2.2.4.104 DhcpFailover
The DhcpFailover complex type allows extended attributes on a BaseIpamObject type (section 2.2.4.64) and models a DHCP Failover relationship between two DHCP servers.
-
<xs:complexType name="DhcpFailover"> <xs:complexContent mixed="false"> <xs:extension base="ipam:BaseIpamObject"> <xs:sequence> <xs:element minOccurs="0" name="AutoStateTransition" type="xsd:boolean" /> <xs:element minOccurs="0" name="MCLT" type="ser:duration" /> <xs:element minOccurs="0" name="Mode" type="ipam:DhcpFailoverMode" /> <xs:element minOccurs="0" name="OperationTracker" nillable="true" type="ipam:ArrayOfDhcpFailoverOperations" /> <xs:element minOccurs="0" name="RecordId" type="xsd:long" /> <xs:element minOccurs="0" name="RelationshipName" nillable="true" type="xsd:string" /> <xs:element minOccurs="0" name="Server1IP" nillable="true" type="sysnet:IPAddress" /> <xs:element minOccurs="0" name="Server1Name" nillable="true" type="xsd:string" /> <xs:element minOccurs="0" name="Server1PSName" nillable="true" type="xsd:string" /> <xs:element minOccurs="0" name="Server1Percentage" type="xsd:unsignedInt" /> <xs:element minOccurs="0" name="Server1RecordId" type="xsd:long" /> <xs:element minOccurs="0" name="Server1State" type="ipam:DhcpFailoverState" /> <xs:element minOccurs="0" name="Server2IP" nillable="true" type="sysnet:IPAddress" /> <xs:element minOccurs="0" name="Server2Name" nillable="true" type="xsd:string" /> <xs:element minOccurs="0" name="Server2PSName" nillable="true" type="xsd:string" /> <xs:element minOccurs="0" name="Server2RecordId" type="xsd:long" /> <xs:element minOccurs="0" name="Server2State" type="ipam:DhcpFailoverState" /> <xs:element minOccurs="0" name="ServerOwner" type="ipam:DhcpFailoverOperationOwner" /> <xs:element minOccurs="0" name="SharedSecret" nillable="true" type="xsd:base64Binary" /> <xs:element minOccurs="0" name="SharedSecretEnabled" type="xsd:boolean" /> <xs:element minOccurs="0" name="StateSwitchInterval" type="ser:duration" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>
AutoStateTransition: A Boolean value that indicates if the associated DhcpFailover object supports automatic transition from the COMM-INTR failover state to the PARTNER DOWN failover state.
MCLT: An object of type TimeSpan, it is used to store the Maximum Client Lead Time of the associated DhcpFailover object.
Mode: A DhcpFailoverMode (section 2.2.5.17) that indicates the mode of functioning of the associated DhcpFailover object, Hot standby / Load Balanced.
OperationTracker: Tracks whether a database update is needed after a failover operation. It is filled in after a DHCP server failover operation.
RecordId: A long int that refers to the record Id in the data store of the corresponding failover relationship.
RelationshipName: A string that stores the name of the failover relationship.
Server1IP: An IpamIPAddress (section 2.2.4.257) that stores the IP address of the primary server in the failover relationship.
Server1Name: A string that stores the name of the primary server as known to IPAM.
Server1PSName: A string that stores the primary server name as returned from the DHCP server.
Server1Percentage: A UINT, that stores the percentage address reserved/allocated for use of the primary server in the failover relationship.
Server1RecordId: A long which stores the data store record Id of the primary server.
Server1State: A DhcpFailoverState (section 2.2.5.20) that stores the failover state of the primary server.
Server2IP: An IpamIPAddress (section 2.2.4.257) that stores the IP address of the secondary server.
Server2Name: A string that stores the name of the secondary server as known to IPAM.
Server2PSName: A string that stores the secondary server name as returned from the DHCP server.
Server2RecordId: A long int and stores the data store record ID of the secondary server.
Server2State: A DhcpFailoverState that stores the failover state of the secondary server.
ServerOwner: A DhcpFailoverOperationOwner (section 2.2.5.18) that identifies which server in the relationship was a failover operation, such as replication, initiated from.
SharedSecret: Stores the encryption secret as an array of bytes.
SharedSecretEnabled: A Boolean that indicates if encryption is enabled for this relationship.
StateSwitchInterval: A TimeSpan that defines the time after which an automatic switch from COMM-INTR to PARTNER DOWN will occur.