Get-Ipam Dhcp Server

Module:
ipamserver
Gets information about DHCP servers from IPAM database.

Syntax 

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

Description

The Get-IpamDhcpServer cmdlet returns information about the Dynamic Host Configuration Protocol (DHCP) servers in the IP Address Management (IPAM) server database. DHCP servers lease IP addresses to client devices.

Examples

Example 1: Get information about all DNS servers 

PS C:\> Get-IpamDhcpServer

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

Example 2: Get information about a single DNS server 

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

This command returns information for a single IPAM DHCP server named dhcp.contoso.com.

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

Specifies the fully qualified domain name (FQDN) of the DHCP server to be returned.

-ServerFqdn "dhcp.contoso.com"

``

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

Outputs

This cmdlet returns an object that represents an instance of the IpamDhcpServer object.