Get-IpamServerInventory

Gets the properties of managed servers in the IPAM server inventory.

Syntax

Get-IpamServerInventory
   -Name <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-IpamServerInventory
   [-AddressFamily <AddressFamily[]>]
   [-ServerType <ServerRole[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-IpamServerInventory cmdlet gets the list of managed servers in the IP Address Management (IPAM) server inventory. Managed servers include the servers that perform domain controller (DC), Dynamic Host Configuration Protocol (DHCP), Domain Name Service (DNS), or Network Policy Server (NPS) roles. You can filter the list of servers based on address family, the type of server role, or a list of fully qualified domain names (FQDNs).

Examples

Example 1: Get all IPv4 servers in the IPAM server inventory

PS C:\> Get-IpamServerInventory -AddressFamily IPv4 | Format-List Name, ServerType
Name       : dhcp1.contoso.com

ServerType : DHCP
Name       : DC1.contoso.com

ServerType : DC

This command gets all IPv4 servers in the IPAM server inventory.

Example 2: Get all IPv4 DHSP servers in the IPAM server inventory

PS C:\> Get-IpamServerInventory -AddressFamily IPv4 -ServerType DHCP| Format-List Name, ServerType
Name       : dhcp1.contoso.com

ServerType : DHCP

This command gets all IPv4 DHCP servers in the IPAM server inventory.

Required Parameters

-Name

Specifies fully qualified domain names of the servers for which to get data.

Type:String
Aliases:ServerName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AddressFamily

Specifies an array of address families to which the infrastructure server belongs.

The acceptable values for this parameter are: IPv4 or IPv6.

Type:AddressFamily[]
Parameter Sets:IPv4, IPv6
Position:Named
Default value:None
Accept pipeline input:False
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
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
-ServerType

Specifies an array of server roles on which to filter the results.

Type:ServerRole[]
Parameter Sets:DC, DNS, DHCP, NPS
Position:Named
Default value:None
Accept pipeline input:False
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

IpamServerInventory

This cmdlet returns an object that represents a managed infrastructure server in IPAM system.