Export (0) Print
Expand All
Expand Minimize

Get-IpamDatabase

Windows Server 2012 R2 and Windows 8.1

Updated: December 18, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-IpamDatabase

Gets configuration settings for the IPAM database.

Syntax

Parameter Set: Default
Get-IpamDatabase [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-IpamDatabase cmdlet gets configuration settings for the IP Address Management (IPAM) database. The cmdlet can get settings for Windows Internal Database (WID) or a Microsoft SQL Server database.

Use the Set-IpamDatabase cmdlet to modify settings IPAM uses to connect to a database.

You must be a local administrator on the IPAM server to run this cmdlet.

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.


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

-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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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.

  • IpamDatabase

    An object that represents the database settings used by IPAM to connect to the datastore.


Examples

Example 1: Get IPAM database properties

This command gets IPAM database properties. In this example, the database type is WID.


PS C:\> Get-IpamDatabase
DatabaseType     : WID

WidSchemaPath : C:\Windows\System32\ipam\Database

DatabaseServer :

DatabaseName : IPAM

DatabasePort :

DatabaseAuthType : Windows

DatabaseUser :

Example 2: Get IPAM database properties for an external database

This command gets IPAM database properties for an external database. In this example, the database type is MSSQL.


PS C:\> Get-IpamDatabase
DatabaseType     : MSSQL

WidSchemaPath :

DatabaseServer : ContosoDB22

DatabaseName : IpamDB1

DatabasePort : 1433

DatabaseAuthType : Windows

DatabaseUser :

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft