Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-DhcpServerv4Failover

Updated: January 9, 2013

Applies To: Windows Server 2012

Get-DhcpServerv4Failover

Gets the failover relationships configured on the Dynamic Host Configuration Protocol (DHCP) server service for the specific failover relationship name.

Syntax

Parameter Set: Name
Get-DhcpServerv4Failover [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ScopeId
Get-DhcpServerv4Failover -ScopeId <IPAddress[]> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-DhcpServerv4Failover cmdlet gets the failover relationships configured on the Dynamic Host Configuration Protocol (DHCP) server service for the specific failover relationship name. If the Name parameter is not specified, then this cmdlet returns all failover relationships defined on the DHCP server service. If the Name parameter does not match a failover relationship, then a non-terminating error will be returned for the specific Name parameter value.

If the ScopeId parameter is specified, then the failover relationships of which the specified scopes are included are returned. The ScopeId parameter values should be failover scopes.

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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

-Name<String[]>

Specifies one or more names of failover relationships for which the properties are returned.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ScopeId<IPAddress[]>

Specifies one or more scope identifiers (IDs), in IPv4 address format. The properties of the failover relationships on the DHCP server service to which these scopes are associated are returned.


Aliases

none

Required?

true

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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

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


Examples

EXAMPLE 1

This example gets the failover relationship information for relationship named SFO-SIN-Failover on the DHCP server service running on the computer named dhcpserver.contoso.com.


PS C:\> Get-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover

EXAMPLE 2

This example gets the failover relationship information for all of the failover relationships on the DHCP server service running on the computer named dhcpserver.contoso.com.


PS C:\> Get-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com

EXAMPLE 3

This example gets the failover relationship information for the failover relationship of which the scope 10.10.10.0 is a part, on the DHCP server service running on the computer named dhcpserver.contoso.com.


PS C:\> Get-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.