Add-DhcpServerv4Failover
Add-DhcpServerv4Failover
Adds a new IPv4 failover relationship on the Dynamic Host Configuration Protocol (DHCP) server service.
Syntax
Parameter Set: LoadBalance
Add-DhcpServerv4Failover [-Name] <String> [-ScopeId] <IPAddress[]> [-PartnerServer] <String> [-AsJob] [-AutoStateTransition <Boolean> ] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Force] [-LoadBalancePercent <UInt32> ] [-MaxClientLeadTime <TimeSpan> ] [-PassThru] [-SharedSecret <String> ] [-StateSwitchInterval <TimeSpan> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: HotStandby
Add-DhcpServerv4Failover [-Name] <String> [-ScopeId] <IPAddress[]> [-PartnerServer] <String> [-AsJob] [-AutoStateTransition <Boolean> ] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Force] [-MaxClientLeadTime <TimeSpan> ] [-PassThru] [-ReservePercent <UInt32> ] [-ServerRole <String> ] [-SharedSecret <String> ] [-StateSwitchInterval <TimeSpan> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-DhcpServerv4Failover cmdlet adds a new IPv4 failover relationship to a Dynamic Host Configuration Protocol (DHCP) server service. The first parameter set adds a failover relationship with load balance mode. The second parameter set adds the failover relationship in hot-standby mode.
This cmdlet creates the failover relationship on both of the DHCP server services with the specified parameters. The ScopeId parameter value specified on the source DHCP server service, or local computer running the DHCP server service is identically setup on the partner DHCP server service.
If the SharedSecret parameter is specified, message digest authentication will be automatically turned on for the newly created failover relationship.
By default, user confirmation will be sought if the SharedSecret parameter is specified.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AutoStateTransition<Boolean>
Specifies the enabled state for automatic state transition from the COMMUNICATION INTERRUPTED state to the PARTNER DOWN state based on expiration of the timer, using the StateSwitchInterval parameter, while in the COMMUNICATION INTERRUPTED state.
The acceptable values for this parameter are: True or False. The default value is False.
If the StateSwitchInterval parameter is specified, then this parameter is automatically set to True.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Specifies that, if the SharedSecret parameter is specified, the user confirmation is required since the SharedSecret parameter value may be transferred in plain text transport in the case of remote management. Specifying this parameter turns off the user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancePercent<UInt32>
Specifies the percentage of DHCP client requests which should be served by the local DHCP server service or the DHCP server service running on the computer specified in the ComputerName parameter. The remaining requests would be served by the partner DHCP server service.
The default value is 50%.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MaxClientLeadTime<TimeSpan>
Specifies the maximum client lead time for the failover relationship. The default value is 1 hour.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the failover relationship to create.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PartnerServer<String>
Specifies the IPv4 address, or host name, of the partner DHCP server service with which the failover relationship is created.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ReservePercent<UInt32>
Specifies the percentage of free IPv4 addresses in the IPv4 address pool of the scope which should be reserved on the standby DHCP server service.
In the case of a failover, the IPv4 address from this reserved pool on the standby DHCP server service will be leased to new DHCP clients.
The default value is 5%.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScopeId<IPAddress[]>
Specifies the scope identifiers, in IPv4 address format, which are to be added to the failover relationship.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServerRole<String>
Specifies the role of the local DHCP server service in the hot standby mode. The acceptable values for this parameter are: Active or Standby.
The default value is Active for the local DHCP server service, such as the partner DHCP server service that is specified will be a standby DHCP server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SharedSecret<String>
Specifies the shared secret to be used for message digest authentication. If not specified, then the message digest authentication is turned off.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StateSwitchInterval<TimeSpan>
Specifies the time interval for which the DHCP server service operates in the COMMUNICATION INTERRUPTED state before transitioning to the PARTNER DOWN state.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Examples
EXAMPLE 1
This example creates a load balance, or active-active, failover relationship between the DHCP server services running on the computers named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service running on the computer named dhcpserver.contoso.com added to the failover relationship. These scopes will be created on the partner DHCP server service running on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. Message authentication is enabled for the server-to-server message exchange with the specified shared secret.
PS C:\> Add-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -PartnerServer dhcpserver2.contoso.com -ScopeId 10.10.10.0,20.20.20.0 -SharedSecret "sEcReT"
EXAMPLE 2
This example creates a hot standby, or active-passive, failover relationship between the DHCP server services running on the computers named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service running on the computer named dhcpserver.contoso.com added to the failover relationship. These scopes will be created on the partner DHCP server service running on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. The DHCP server service running on the computer named dhcpserver.contoso.com will be the standby DHCP server service and the DHCP server service running on the computer named dhcpserver2.contoso.com will be the active DHCP server service in the failover relationship.
PS C:\> Add-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -PartnerServer dhcpserver2.contoso.com -ServerRole Standby -ScopeId 10.10.10.0,20.20.20.0
EXAMPLE 3
This example creates a load balance, or active-active, failover relationship between the DHCP server services running on the computer named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service running on the computer named dhcpserver.contoso.com added to the failover relationship. These scopes will be created on the partner DHCP server service running on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. 70% of the client requests will be served by DHCP server service running on the computer named dhcpserver.contoso.com and 30% by the DHCP server service running on the computer named dhcpserver2.contoso.com. The maximum client lead time for the failover relationship is set to 2 hours. The automatic state transition from the COMMUNICATION INTERRUPTED state to the PARTNER DOWN state is turned on and the timer for automatic state transition is set to 2 hours.
PS C:\> Add-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -PartnerServer dhcpserver2.contoso.com -ScopeId 10.10.10.0,20.20.20.0 -LoadBalancePercent 70 -MaxClientLeadTime 2:00:00 -AutoStateTransition $true -StateSwitchInterval 2:00:00
EXAMPLE 4
This example creates a hot standby, or Active-Passive, failover relationship between the DHCP server service running on the computer named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service running on the computer named dhcpserver.contoso.com added to the failover relationship. These scopes will be created on the partner DHCP server service running on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. The DHCP server service running on the computer named dhcpserver2.contoso.com will be standby DHCP server service and the DHCP server service running on the computer named dhcpserver.contoso.com will be the active DHCP server service in the failover relationship. 10% of the free IP addresses in the scopes will be reserved for the standby DHCP server service. The maximum client lead time for the failover relationship is set to 2 hours. The automatic state transition from the COMMUNICATED INTERUPTED state to the PARTNER DOWN state is turned on and the timer for automatic state transition is set to 2 hours.
PS C:\> Add-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -PartnerServer dhcpserver2.contoso.com -ScopeId 10.10.10.0,20.20.20.0 -ReservePercent 10 -MaxClientLeadTime 2:00:00 -AutoStateTransition $true -StateSwitchInterval 2:00:00
Related topics
Invoke-DhcpServerv4FailoverReplication