Set-DhcpServerv4Failover
Set-DhcpServerv4Failover
Modifies the properties of an existing failover relationship.
Syntax
Parameter Set: Set1
Set-DhcpServerv4Failover [-Name] <String> [-AsJob] [-AutoStateTransition <Boolean> ] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Force] [-LoadBalancePercent <UInt32> ] [-MaxClientLeadTime <TimeSpan> ] [-PartnerDown] [-PassThru] [-ReservePercent <UInt32> ] [-SharedSecret <String> ] [-StateSwitchInterval <TimeSpan> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-DhcpServerv4Failover cmdlet modifies the properties of an existing failover relationship.
If the failover mode of relation is Load Balance mode, then the LoadBalancePercent, MaxClientLeadTime, StateSwitchInterval, AutoStateTransition, SharedSecret, and PartnerDown parameters can be specified.
If the failover mode of relation is Hot Standby mode, then the ReservePercent, MaxClientLeadTime, StateSwitchInterval, AutoStateTransition, SharedSecret, and PartnerDown parameters can be specified.
If the SharedSecret parameter is specified, then the message digest authentication is enabled for the failover relationship.
If the SharedSecret parameter value is specified as Null, then enableauth will be set to False in the data structure.
If the SharedSecret parameter is specified, then confirmation will be sought from the user to transport the shared secret in the clear text on the network.
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.
Note: This parameter value is set to True, if the StateSwitchInterval parameter is specified.
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 Dynamic Host Configuration Protocol (DHCP) server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Specifies, if the SharedSecret parameter is specified, that 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 DHCP client requests would be served by the partner DHCP server service.
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of failover relationship for which the properties are modified.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PartnerDown
Changes the state of the DHCP server service from COMMUNICATION INTERRUPTED to PARTNER DOWN.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 the free IPv4 address pool for the scope which should be reserved on the standby DHCP server service.
In the case of a failover, the IPv4 addresses from this reserved pool on the standby DHCP server service will be leased to new DHCP clients.
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 authentication. To turn off message authentication, set this parameter value to Null.
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 should continue to operate 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/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.
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 modifies the parameters of the Load Balance failover relationship named SFO-SIN-Failover on the computer named dhcpserver.contoso.com as follows: 70% of the client requests will be served by the DHCP server service running on the computer named dhcpserver.contoso.com and 30% of the client requests will be served 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 enabled and the timer for automatic state transition is set to 2 hours.
PS C:\> Set-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -LoadBalancePercent 70 -MaxClientLeadTime 2:00:00 -AutoStateTransition True -StateSwitchInterval 2:00:00
EXAMPLE 2
This example modifies the parameters of the Hot Standby failover relationship named SFO-SIN-Failover on computer named dhcpserver.contoso.com as follows: 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 COMMUNICATION INTERRUPTED state to the PARTNER DOWN state is enabled and the timer for automatic state transition is set to 2 hours.
PS C:\> Set-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -ReservePercent 10 -MaxClientLeadTime 2:00:00 -AutoStateTransition True -StateSwitchInterval 2:00:00