Export (0) Print
Expand All

Get-OdbcDsn

Windows Server 2012 R2 and Windows 8.1

Updated: June 5, 2014

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

Get-OdbcDsn

Gets ODBC DSNs.

Syntax

Parameter Set: Get1
Get-OdbcDsn [[-Name] <String> ] [-AsJob] [-CimSession <CimSession> ] [-DriverName <String> ] [-DsnType <String> ] [-Platform <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-OdbcDsn cmdlet gets Open Database Connectivity (ODBC) data source names (DSNs) from the computer. You can specify values for the Name, DsnType, Platform, and DriverName parameters. If you do not specify Name or DriverName, the cmdlet gets all DSN names and all driver names respectively. If you do not specify any parameter, the cmdlet gets all ODBC DSNs from the computer.

For more information about ODBC, data source names, and drivers, see Microsoft Open Database Connectivity (ODBC) (http://msdn.microsoft.com/en-us/library/ms710252.aspx), Data Sources (http://msdn.microsoft.com/en-us/library/ms711688.aspx), and Drivers (http://msdn.microsoft.com/en-us/library/ms711688.aspx) on the Microsoft Developer Network.

Parameters

-Name<String>

Specifies the name of an ODBC DSN. You can use wildcard characters to specify more than one ODBC DSN. If you do not specify this parameter, this cmdlet returns all ODBC DSNs.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-DsnType<String>

Specifies the type of an ODBC DSN. This cmdlet gets DSNs of the type that this parameter specifies. The acceptable values for this parameter are: 

-- User
-- System
-- All

The default value is All.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Platform<String>

Specifies the platform architecture. This cmdlet gets the ODBC DSN that belong to the architecture that this parameter specifies. The acceptable values for this parameter are: 

-- 32-bit
-- 64-bit
-- All

The default value is All. If you run this cmdlet in a remote CIM session, this parameter refers to the platform architecture on the remote computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-DriverName<String>

Specifies the name of a driver. This cmdlet gets ODBC DSNs that use the specified ODBC driver. You can use wildcard characters. If you do not specify this parameter, this cmdlet gets all ODBC DSNs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-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

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.

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

Example 1: Get all DSNs

This command gets all ODBC User DSNs and System DSNs that use 32-bit or 64-bit ODBC drivers.


PS C:\> Get-OdbcDsn

Example 2: Get ODBC System DSNs by name

This command gets the ODBC System DSNs named MyPayroll stored in the 32-bit registry location.


PS C:\> Get-OdbcDsn -Name "MyPayroll" -DsnType "System" -Platform "32-bit"

Example 3: Get ODBC DSNs with names that contain a string

This command gets all ODBC User DSNs and System DSNs with names that contain the string Payroll. The DSNs are stored in the native hive of the registry location.


PS C:\> Get-OdbcDsn -Name "*Payroll*"

Example 4: Get all ODBC User DSNs for specified driver

This command gets all ODBC User DSNs that use a driver that has the specified name, and then stores those DSN in the $dsnArray variable.


PS C:\> $dsnArray = Get-OdbcDsn -DriverName "SQL Server*"

Related topics

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