Get-OdbcDsn
Get-OdbcDsn
Retrieves one or more ODBC data source names (DSNs) from the system that match the value passed to the Name, DsnType, Platform, and DriverName parameters. If the Name or DriverName parameter is not specified, the default is to match all DSN names and all driver names respectively. If no parameters are provided, retrieves all ODBC DSNs from the system.
Syntax
Parameter Set: Get1
Get-OdbcDsn [[-Name] <String> ] [-AsJob] [-CimSession <CimSession> ] [-DriverName <String> ] [-DsnType <String> ] [-Platform <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
For more information about ODBC, data source names, and drivers, see Microsoft Open Database Connectivity (ODBC), Data Sources, and Drivers.
Parameters
-Name<String>
Specifies one or more ODBC DSNs by DSN name. You can use wildcard characters. The default is to return all ODBC DSNs.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-DsnType<String>
The type of the ODBC DSN to retrieve. Possible values are 'User', 'System' or 'All'. The default is 'All'.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Platform<String>
The platform architecture of the ODBC DSN to retrieve. Possible values are '32-bit', '64-bit' or 'All'. The default is 'All'. This is the platform architecture on the remote machine if this command is executed in a remote CIM session.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DriverName<String>
Gets only ODBC DSNs that are using the specified ODBC driver. You can use wildcard characters. The default is to return all ODBC DSNs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-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 |
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: -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.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_OdbcDsn[]
Examples
This command gets all ODBC User DSN(s) and System DSN(s) that are using 32-bit or 64-bit ODBC drivers:
PS C:\> Get-OdbcDsn
This command gets the ODBC System DSN(s) named as "MyPayroll" which is stored in the 32-bit registry location. The Name parameter is positioned at 0:
PS C:\> Get-OdbcDsn "MyPayroll" -DsnType System -Platform 32-bit
This command gets all ODBC User DSN(s) and System DSN(s) with name matches the wildcard and which is stored in the native hive of the registry location:
PS C:\> Get-OdbcDsn -Name "*Payroll*"
This command gets all ODBC User DSN(s) that is using a driver with a name matching the above wildcard. It also saves the result into a PowerShell variable for future use:
PS C:\> $dsnArray = Get-OdbcDsn -DriverName "SQL Server*"
Related topics
N:Wdac