Get-IpamServerInventory

Get-IpamServerInventory

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

Syntax

Parameter Set: ByAddressFamily
Get-IpamServerInventory [-AddressFamily <AddressFamily[]> ] [-CimSession <CimSession[]> ] [-ServerType <ServerRole[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByName
Get-IpamServerInventory -Name <String> [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>] [ <WorkflowParameters>]




Detailed 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).

Parameters

-AddressFamily<AddressFamily[]>

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

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<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.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

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


Aliases

ServerName

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ServerType<ServerRole[]>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • IpamServerInventory

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


Examples

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

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


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

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

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


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

Related topics

Community Additions

ADD
Show: