Edit

Share via

Add-DhcpServerv4Failover

Module:
DhcpServer Module

Adds an IPv4 failover relationship on the DHCP server service.

Syntax

LoadBalance (Default) 

Add-DhcpServerv4Failover
    [-Name] <String>
    [-PartnerServer] <String>
    [-ScopeId] <IPAddress[]>
    [-ComputerName <String>]
    [-MaxClientLeadTime <TimeSpan>]
    [-AutoStateTransition <Boolean>]
    [-StateSwitchInterval <TimeSpan>]
    [-Force]
    [-SharedSecret <String>]
    [-PassThru]
    [-LoadBalancePercent <UInt32>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HotStandby 

Add-DhcpServerv4Failover
    [-Name] <String>
    [-PartnerServer] <String>
    [-ScopeId] <IPAddress[]>
    [-ComputerName <String>]
    [-MaxClientLeadTime <TimeSpan>]
    [-AutoStateTransition <Boolean>]
    [-StateSwitchInterval <TimeSpan>]
    [-Force]
    [-SharedSecret <String>]
    [-PassThru]
    [-ReservePercent <UInt32>]
    [-ServerRole <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Add-DhcpServerv4Failover cmdlet adds a new IPv4 failover relationship to a Dynamic Host Configuration Protocol (DHCP) server service. You can add a failover relationship with load balance mode or in hot-standby mode.

This cmdlet creates the failover relationship on both of the DHCP server services that use the specified parameters. The ScopeId parameter value specified on the source DHCP server service, or local computer that runs 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.

Examples

Example 1: Create an active-active failover relationship

PS C:\> Add-DhcpServerv4Failover -ComputerName "dhcpserver.contoso.com" -Name "SFO-SIN-Failover" -PartnerServer "dhcpserver2.contoso.com" -ScopeId 10.10.10.0,10.20.20.0 -SharedSecret "sEcReT"

This example creates a load balance, or active-active, failover relationship between the DHCP server services that runs on the computers named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 10.20.20.0 present on the DHCP server service that runs on the computer named dhcpserver.contoso.com added to the failover relationship. These scopes will be created on the partner DHCP server service that runs 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.

Example 2: Create an active-passive 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,10.20.20.0

This example creates a hot standby, or active-passive, failover relationship between the DHCP server services that runs on the computers named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 10.20.20.0 present on the DHCP server service that runs on the computer named dhcpserver.contoso.com added to the failover relationship. These scopes will be created on the partner DHCP server service that runs on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. The DHCP server service that runs on the computer named dhcpserver.contoso.com will be the standby DHCP server service and the DHCP server service that runs on the computer named dhcpserver2.contoso.com will be the active DHCP server service in the failover relationship.

Example 3: Create an active-active failover relationship with specified load balance amount

PS C:\> Add-DhcpServerv4Failover -ComputerName "dhcpserver.contoso.com" -Name "SFO-SIN-Failover" -PartnerServer "dhcpserver2.contoso.com" -ScopeId 10.10.10.0,10.20.20.0 -LoadBalancePercent 70 -MaxClientLeadTime 2:00:00 -AutoStateTransition $True -StateSwitchInterval 2:00:00

This example creates a load balance, or active-active, failover relationship between the DHCP server services that runs on the computer named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 10.20.20.0 present on the DHCP server service that runs on the computer named dhcpserver.contoso.com added to the failover relationship. These scopes will be created on the partner DHCP server service that runs 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 that runs on the computer named dhcpserver.contoso.com and 30% by the DHCP server service that runs 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.

Example 4: Create an active-passive failover relationship with reserve

PS C:\> Add-DhcpServerv4Failover -ComputerName "dhcpserver.contoso.com" -Name "SFO-SIN-Failover" -PartnerServer "dhcpserver2.contoso.com" -ScopeId 10.10.10.0,10.20.20.0 -ReservePercent 10 -MaxClientLeadTime 2:00:00 -AutoStateTransition $True -StateSwitchInterval 2:00:00

This example creates a hot standby, or active-passive, failover relationship between the DHCP server service that runs on the computer named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 10.20.20.0 present on the DHCP server service that runs on the computer named dhcpserver.contoso.com added to the failover relationship. These scopes will be created on the partner DHCP server service that runs on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. The DHCP server service that runs on the computer named dhcpserver2.contoso.com will be standby DHCP server service and the DHCP server service that runs 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.

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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, 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, this parameter is automatically set to True.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ComputerName

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Cn

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Specifies that, if the SharedSecret parameter is specified, the 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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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 requests would be served by the partner DHCP server service.

The default value is 50%.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

LoadBalance
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxClientLeadTime

Specifies the maximum client lead time for the failover relationship. The default value is 1 hour.

Parameter properties

Type:TimeSpan
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies the name of the failover relationship to create.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PartnerServer

Specifies the IPv4 address, or host name, of the partner DHCP server service with which the failover relationship is created.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReservePercent

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.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

HotStandby
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ScopeId

Specifies the scope identifiers, in IPv4 address format, which are to be added to the failover relationship.

Parameter properties

Type:

IPAddress[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ServerRole

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.

Parameter properties

Type:String
Default value:None
Accepted values:Active, Standby
Supports wildcards:False
DontShow:False

Parameter sets

HotStandby
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SharedSecret

Specifies the shared secret to be used for message digest authentication. If not specified, the message digest authentication is turned off.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StateSwitchInterval

Specifies the time interval for which the DHCP server service operates in the COMMUNICATION INTERRUPTED state before transitioning to the PARTNER DOWN state.

Parameter properties

Type:TimeSpan
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

CimInstance

The Microsoft.Management.Infrastructure.CimInstance object 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

CimInstance

The Microsoft.Management.Infrastructure.CimInstance object 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.