Edit

Get-IpamDhcpSuperscope

  • Reference
Module:
IpamServer

Gets information about DHCP superscopes from IPAM database.

Syntax

Get-IpamDhcpSuperscope
   [[-SuperscopeName] <String[]>]
   [[-ServerFqdn] <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-IpamDhcpSuperscope cmdlet gets information about Dynamic Host Configuration Protocol (DHCP) superscopes in the IP Address Management (IPAM) server database. Scopes represent the IP addresses that a DHCP server can lease to clients. In most cases, scopes correspond to IP subnets. As a general rule, DHCP servers can only lease addresses from a single scope. However, superscopes provide a mechanism that allows a DHCP server to lease addresses from multiple scopes. Superscopes are only available for IPv4 addresses.

Examples

Example 1: Get information about all the superscopes

PS C:\> Get-IpamDhcpSuperscope

This command returns information about all the DHCP superscopes in the IPAM database.

Example 2: Get information about all superscopes on a server

PS C:\> Get-IpamDhcpSuperscope -ServerFqdn "dhcp.contoso.com"

This command returns all the DHCP superscopes found on the DHCP server named dhcp.contoso.com.

Example 3: Get information for a single superscope

PS C:\> Get-IpamDhcpSuperscope -ServerFqdn "dhcp.contoso.com"-SuperscopeName "SuperScope01"

This command returns information for a single DHCP superscope named SuperScope01 that is located on the server named dhcp.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

-ServerFqdn

Specifies the fully qualified domain name of the DHCP server hosting the DHCP superscopes to be retrieved. For example:

-ServerFqdn "dhcp.contoso.com"

``

Type:String[]
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SuperscopeName

Specifies the name of the DNS superscope to be retrieved. For example: .

-SuperscopeName "Pacific Northwest"

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

Outputs

This cmdlet returns an object that represents an instance of Get-IpamDhcpSuperscope.