Edit

Share via

Get-IpamDhcpScope

  • Reference
Module:
IpamServer

Gets information about DHCP scopes from IPAM database.

Syntax

Get-IpamDhcpScope
   [-AddressFamily] <AddressFamily[]>
   [[-ScopeId] <IPAddress[]>]
   [[-ServerFqdn] <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-IpamDhcpScope cmdlet retrieves information about the Dynamic Host Configuration Protocol (DHCP) scopes in the IP Address Management (IPAM) 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. See the Get-IpamDhcpSuperscope cmdlet for more information.

Examples

Example 1: Get information about all IPv4 scopes

PS C:\> Get-IpamDhcpScope -AddressFamily "IPv4"

This command returns all the IPv4 DHCP scopes found in the IPAM database.

Example 2: Get information about the IPv4 scopes on a specific server

PS C:\> Get-IpamDhcpScope -AddressFamily "IPv4" -ServerFqdn "dhcp.contoso.com"

This command also returns IPv4 DHCP scopes. In this case, however, the only scopes returned are the ones found on the server dhcp.contoso.com.

Parameters

-AddressFamily

Specifies the address family for the DHCP scopes that this cmdlet gets.

The acceptable values for this parameter are:

  • IPv4
  • IPv6
Type:AddressFamily[]
Accepted values:IPv4, IPv6
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-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

-ScopeId

Specifies the ID of the DHCP scope that this cmdlet gets.

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

-ServerFqdn

Specifies the fully qualified domain name (FQDN) of the DHCP server hosting the DHCP scopes that this cmdlet gets.

Type:String[]
Position:3
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

IpamDhcpScope

This cmdlet returns an object that represents an IpamDhcpScope object.