primary¶
- primary¶
The primary server of a DHCP failover object.
Type
String.
Create
The field is required only when creating a DHCP failover object associated with the Grid.
Search
The field is not available for search.
DHCP failover is a protocol designed to allow a backup DHCP server to take over for a main server if the main server is taken off the network for any reason. DHCP failover can be used to configure two DHCP servers to operate as a redundant pair.
References to dhcpfailover are object references.
The name part of the dhcpfailover object reference has the following components:
- Name of the DHCP Failover Association object
- Address of the primary Microsoft Server object, if you create failover association between two Microsoft Servers
Example: dhcpfailover/ZG5zLm5ldHdvcmtfdmlldyQxMTk:dhcpf1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): name.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| ms_failover_partner | See the field description for more information |
| ms_server | See the field description for more information |
| name | |
| primary | See the field description for more information |
| primary_server_type | See the field description for more information |
| secondary | See the field description for more information |
| secondary_server_type | See the field description for more information |
The value indicating whether the failover assoctaion is Microsoft or Grid based. This is a read-only attribute.
Type
String.
Search
The field is not available for search.
Notes
The association_type cannot be updated.
association_type cannot be written.
A descriptive comment about a DHCP failover object.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
Determines the TCP port on which the server should listen for connections from its failover peer. Valid values are between 1 and 63999.
Type
Unsigned integer.
Create
The default value is 647.
Search
The field is not available for search.
Notes
failover_port is associated with the field use_failover_port (see use flag).
A load balancing split value of a DHCP failover object. Specify the value of the maximum load balancing delay in a 8-bit integer format (range from 0 to 256).
Type
Unsigned integer.
Create
The default value is 128.
Search
The field is not available for search.
The maximum client lead time value of a DHCP failover object. Specify the value of the maximum client lead time in a 32-bit integer format (range from 0 to 4294967295) that represents the duration in seconds. Valid values are between 1 and 4294967295.
Type
Unsigned integer.
Create
The default value is 3600.
Search
The field is not available for search.
The maximum load balancing delay value of a DHCP failover object. Specify the value of the maximum load balancing delay in a 32-bit integer format (range from 0 to 4294967295) that represents the duration in seconds. Valid values are between 1 and 4294967295.
Type
Unsigned integer.
Create
The default value is 3.
Search
The field is not available for search.
The maximum response delay value of a DHCP failover object. Specify the value of the maximum response delay in a 32-bit integer format (range from 0 to 4294967295) that represents the duration in seconds. Valid values are between 1 and 4294967295.
Type
Unsigned integer.
Create
The default value is 60.
Search
The field is not available for search.
The maximum number of unacked updates value of a DHCP failover object. Specify the value of the maximum number of unacked updates in a 32-bit integer format (range from 0 to 4294967295) that represents the number of messages. Valid values are between 1 and 4294967295.
Type
Unsigned integer.
Create
The default value is 10.
Search
The field is not available for search.
The value that indicates whether the failover association is read-write or read-only. This is a read-only attribute.
Type
String.
Search
The field is not available for search.
Notes
The ms_association_mode cannot be updated.
ms_association_mode cannot be written.
Determines if the authentication for the failover association is enabled or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines if the switchover interval is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The mode for the failover association.
Type
String.
Create
The default value is LOADBALANCE.
Search
The field is not available for search.
Failover partner defined in the association with the Microsoft Server.
Type
String.
Create
The field is required only when creating a DHCP failover object associated with a Microsoft Server.
Search
The field is not available for search.
Notes
The ms_failover_partner cannot be updated.
The partner role in the case of HotStandby.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Determines if the matching Microsfot failover association (if any) is in synchronization (False) or not (True). If there is no matching failover association the returned values is False. This is a read-only attribute.
Type
Bool.
Search
The field is not available for search.
Notes
The ms_is_conflict cannot be updated.
ms_is_conflict cannot be written.
The previous failover association state. This is a read-only attribute.
Type
String.
Search
The field is not available for search.
Notes
The ms_previous_state cannot be updated.
ms_previous_state cannot be written.
The primary Microsoft Server.
Type
String.
Create
The field is required only when creating a DHCP failover object associated with a Microsoft Server.
Search
The field is not available for search.
Notes
The ms_server cannot be updated.
The failover association state. This is a read-only attribute.
Type
String.
Search
The field is not available for search.
Notes
The ms_state cannot be updated.
ms_state cannot be written.
The time (in seconds) that DHCPv4 server will wait before transitioning the server from the COMMUNICATION-INT state to PARTNER-DOWN state.
Type
Unsigned integer.
Create
The default value is 3600.
Search
The field is not available for search.
Notes
ms_switchover_interval is associated with the field use_ms_switchover_interval (see use flag).
The name of a DHCP failover object.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
The primary server of a DHCP failover object.
Type
String.
Create
The field is required only when creating a DHCP failover object associated with the Grid.
Search
The field is not available for search.
The type of the primary server of DHCP Failover association object.
Type
String.
Create
The field is required only when creating a DHCP failover object associated with the Grid.
Search
The field is not available for search.
The primary server status of a DHCP failover object.
Type
String.
Search
The field is not available for search.
Notes
The primary_state cannot be updated.
primary_state cannot be written.
Determines if the leases are kept in recycle bin until one week after expiration or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Notes
recycle_leases is associated with the field use_recycle_leases (see use flag).
The secondary server of a DHCP failover object.
Type
String.
Create
The field is required only when creating a DHCP failover object associated with the Grid.
Search
The field is not available for search.
The type of the secondary server of DHCP Failover association object.
Type
String.
Create
The field is required only when creating a DHCP failover object associated with the Grid.
Search
The field is not available for search.
The secondary server status of a DHCP failover object.
Type
String.
Search
The field is not available for search.
Notes
The secondary_state cannot be updated.
secondary_state cannot be written.
Use flag for: failover_port
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use this function to set DHCP failover to the Partner Down state.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
peer_type ( String. Valid values are: “PRIMARY”, “SECONDARY” ). This parameter is mandatory. The DHCP failover peer type.
Output fields
None
Use this function to force the Recovery state of the secondary failover peer.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
None
Output fields
None
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| association_type | String | N | Y | N | N/A |
| comment | String | N | N | N | : = ~ |
| extattrs | Extattr | N | N | N | ext |
| failover_port | Unsigned int | N | N | N | N/A |
| load_balance_split | Unsigned int | N | N | N | N/A |
| max_client_lead_time | Unsigned int | N | N | N | N/A |
| max_load_balance_delay | Unsigned int | N | N | N | N/A |
| max_response_delay | Unsigned int | N | N | N | N/A |
| max_unacked_updates | Unsigned int | N | N | N | N/A |
| ms_association_mode | String | N | Y | N | N/A |
| ms_enable_authentication | Bool | N | N | N | N/A |
| ms_enable_switchover_interval | Bool | N | N | N | N/A |
| ms_failover_mode | String | N | N | N | N/A |
| ms_failover_partner | String | Y* | N | N | N/A |
| ms_hotstandby_partner_role | String | N | N | N | N/A |
| ms_is_conflict | Bool | N | Y | N | N/A |
| ms_previous_state | String | N | Y | N | N/A |
| ms_server | String | Y* | N | N | N/A |
| ms_shared_secret | String | N | N | N | N/A |
| ms_state | String | N | Y | N | N/A |
| ms_switchover_interval | Unsigned int | N | N | N | N/A |
| name | String | Y | N | Y | = ~ |
| primary | String | Y* | N | N | N/A |
| primary_server_type | String | Y* | N | N | N/A |
| primary_state | String | N | Y | N | N/A |
| recycle_leases | Bool | N | N | N | N/A |
| secondary | String | Y* | N | N | N/A |
| secondary_server_type | String | Y* | N | N | N/A |
| secondary_state | String | N | Y | N | N/A |
| use_failover_port | Bool | N | N | N | N/A |
| use_ms_switchover_interval | Bool | N | N | N | N/A |
| use_recycle_leases | Bool | N | N | N | N/A |
* Required in some cases, see detailed field description above.
dhcp:statistics : DHCP Statistics object.