Get-DhcpServerv4Superscope

  • Reference
Module:
DhcpServer

Gets the configuration for the specified superscope.

Syntax

Get-DhcpServerv4Superscope
   [[-SuperscopeName] <String[]>]
   [-ComputerName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-DhcpServerv4SuperScope cmdlet gets the configuration for the specified superscope. If you do not specify the SuperscopeName parameter, all of the superscopes present on the Dynamic Host Configuration Protocol (DHCP) server service are returned.

Examples

Example 1: Get all superscopes and associated scopes

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

This example gets all of the superscopes and the associated scopes on the specified DHCP server service.

Example 2: Get a superscope and associated scopes

PS C:\> Get-DhcpServerv4SuperScope -ComputerName "dhcpserver.contoso.com" -SuperscopeName "ExtendedLabNet"

This example gets the configuration for the superscope named ExtendedLabNet and the associated scopes on the specified DHCP server service on the computer named dhcpserver.contoso.com.

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
Required:False
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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SuperscopeName

Specifies the name of the superscopes whose configuration this cmdlet gets.

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

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.