Get-IpamDatabase
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
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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
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