Invoke-Dhcp Serverv4Failover Replication

Module:
dhcpserver
Replicates scope configuration between failover partner DHCP server services.

Syntax 

Invoke-DhcpServerv4FailoverReplication
      [-ComputerName <String>]
      [-Force]
      [[-Name] <String[]>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-DhcpServerv4FailoverReplication
      [-ComputerName <String>]
      [-Force]
      -ScopeId <IPAddress[]>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Invoke-DhcpServerv4FailoverReplication cmdlet replicates scope configuration between failover partner Dynamic Host Configuration Protocol (DHCP) server services.

If you specify the ScopeId parameter, if the scope is part of a failover relationship, the scope configuration for the specified scopes is replicated to the failover partner DHCP server service. The scope configuration includes all scope properties, reservations, scope option values, and policies.

If you specify the Name parameter, the configuration for all of the scopes which are part of the failover relationship is replicated to the partner DHCP server service.

If you specify no parameters, the configuration for all of the failover scopes on the DHCP server service will be replicated to the respective partner DHCP server services.

Examples

Example 1: Replicate configuration of scopes for a failover relationship 

PS C:\> Invoke-DhcpServerv4FailoverReplication -ComputerName "dhcpserver.contoso.com" -Name "SFO-SIN-Failover"

This example replicates the configuration of all scopes which are part of the failover relationship named SFO-SIN-Failover on the DHCP server service that runs on the computer named dhcpserver.contoso.com to the partner DHCP server service.

Example 2: Replicate configuration of scopes for failover relationships for a server 

PS C:\> Invoke-DhcpServerv4FailoverReplication -ComputerName "dhcpserver.contoso.com"

This example replicates all of the failover scopes on the DHCP server service that runs on the computer named dhcpserver.contoso.com to one or more respective partner DHCP server services based on one or more failover relationships in which the DHCP server services are included.

Example 3: Replicate configuration of scopes 

PS C:\> Invoke-DhcpServerv4FailoverReplication -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0,10.20.20.0

This example replicates the configuration of the scopes 10.10.10.0 and 10.20.20.0 to the respective partner computers that runs the DHCP server services of the failover relationships in which the scopes are included.

Required Parameters

-ScopeId

Specifies the scope identifier (ID), in IPv4 address format, whose configuration are replicated.

Type: IPAddress[]
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

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

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName

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

Type: String
Aliases: Cn
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies the name of the failover relationship. All scopes for one or more specified relationships are replicated to the partner DHCP server service.

Type: String[]
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

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

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Inputs

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover

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.

Inputs

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope

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

System.String[]