Set-DhcpServerv4Failover

Set-DhcpServerv4Failover is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.

Synopsis

Modifies the properties of an existing failover relationship.

Description

The Set-DhcpServerv4Failover cmdlet modifies the properties of an existing failover relationship.

If the failover mode of relation is load balance or is being changed to load balance , then the LoadBalancePercent, MaxClientLeadTime, StateSwitchInterval, AutoStateTransition, and SharedSecret parameters can be specified.

If the failover mode of relation is hot standby or is being changed to hot standby, then the ReservePercent, MaxClientLeadTime, StateSwitchInterval, AutoStateTransition, and SharedSecret parameters can be specified.

If the SharedSecret parameter value is Null, then enableauth will be set to False in the data structure. If the SharedSecret parameter is not Null, then enableauth will be set to True 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.

If you specify the Mode parameter to change the mode of the failover relationship, default confirmation will be sought.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell background jobs, see about_Jobs.

-AutoStateTransition

Specifies the enabled state for automatic state transition from the COMMUNICATION INTERRUPTED state to the PARTNER DOWN state based on expiration of the timer, by using the StateSwitchInterval parameter, while in the COMMUNICATION INTERRUPTED state. The default value is $False.

This parameter value is $True, if the StateSwitchInterval parameter is specified.

-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.

-ComputerName

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the Dynamic Host Configuration Protocol (DHCP) server service.

-Confirm

Prompts you for confirmation before running the cmdlet.

-Force

Specifies, if the SharedSecret parameter is specified, that user confirmation is required because the SharedSecret parameter value may be transferred in plain text transport for remote management. Specifying this parameter turns off the user confirmation.

-LoadBalancePercent

Specifies the percentage of DHCP client requests which should be served by the local DHCP server service or the DHCP server service that runs on the computer specified in the ComputerName parameter. The remaining DHCP client requests would be served by the partner DHCP server service.

-MaxClientLeadTime

Specifies the maximum client lead time for the failover relationship.

-Mode

Specifies a mode for the failover relationship. The acceptable values for this parameter are:

-Name

Specifies the name of failover relationship for which the properties are modified.

-PartnerDown

Changes the state of the DHCP server service from COMMUNICATION INTERRUPTED to PARTNER DOWN.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-ReservePercent

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.

-SharedSecret

Specifies the shared secret to be used for message authentication. To turn off message authentication, set this parameter value to $Null.

-StateSwitchInterval

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.

-ThrottleLimit

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.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Syntax

Set-DhcpServerv4Failover [-ComputerName <String>] [-Name] <String> [-AutoStateTransition <Boolean>] [-MaxClientLeadTime <TimeSpan>] [-SharedSecret <String>] [-StateSwitchInterval <TimeSpan>] [-PartnerDown] [-Force] [-LoadBalancePercent <UInt32>] [-ReservePercent <UInt32>] [-PassThru] [-Mode <String>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]

—————EXAMPLE 1—————
PS C:>Set-DhcpServerv4Failover -ComputerName dhcpsrv.TOSSolution.com -Name SFO-SIN-Failover -LoadBalancePercent 70 -MaxClientLeadTime 2:00:00 -AutoStateTransition True -StateSwitchInterval 2:00:00
This example modifies the parameters of the load balance failover relationship named SFO-SIN-Failover on the computer named dhcpsrv.TOSSolution.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 dhcpsrv2.TOSSolution.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.

—————EXAMPLE 2—————
PS C:\>Set-DhcpServerv4Failover -ComputerName dhcpsrv.TOSSolution.com -Name SFO-SIN-Failover -ReservePercent 10 -MaxClientLeadTime 2:00:00 -AutoStateTransition True -StateSwitchInterval 2:00:00
This example modifies the parameters of the hot standby failover relationship named SFO-SIN-Failover on computer named dhcpsrv.TOSSolution.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.

—————EXAMPLE 3—————
PS C:\>Set-DhcpServerv4Failover -Name SFO-SIN-Failover -ComputerName dhcpsrv.TOSSolution.com -Mode LoadBalance -LoadBalancePercent 60
This example changes the mode of the failover relationship SFO-SIN-Failover to LoadBalance. The computer named dhcpsrv.TOSSolution.com serves 60 percent of the clients.

Get-Command Set-DhcpServerv4Failover

You can also read about

To know more PowerShell cmdlets(Commands) on DHCPServer click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft