< Back
Get-OdbcDsn
Post
NAME Get-OdbcDsn
SYNOPSIS
Gets ODBC DSNs.
SYNTAX
Get-OdbcDsn [[-Name] <String>] [-CimSession <CimSession[]>] [-DriverName <String>] [-DsnType {User | System | All}] [-Platform {32-bit | 64-bit | All}]
[-ThrottleLimit <Int32>] [<CommonParameters>]
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.
Required? false
Position? 1
Default value none
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-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.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? true (ByPropertyName)
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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#MSFT_OdbcDsn[]
Example 1: Get all DSNs
PS C:\\> Get-OdbcDsn
This command gets all ODBC User DSNs and System DSNs that use 32-bit or 64-bit ODBC drivers.
Example 2: Get ODBC System DSNs by name
PS C:\\> Get-OdbcDsn -Name "MyPayroll" -DsnType "System" -Platform "32-bit"
This command gets the ODBC System DSNs named MyPayroll stored in the 32-bit registry location.
Example 3: Get ODBC DSNs with names that contain a string
PS C:\\> Get-OdbcDsn -Name "*Payroll*"
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.
Example 4: Get all ODBC User DSNs for specified driver
PS C:\\> $DsnArray = Get-OdbcDsn -DriverName "SQL Server*"
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.
RELATED LINKS
Add-OdbcDsn
Remove-OdbcDsn
Set-OdbcDsn
SYNOPSIS
Gets ODBC DSNs.
SYNTAX
Get-OdbcDsn [[-Name] <String>] [-CimSession <CimSession[]>] [-DriverName <String>] [-DsnType {User | System | All}] [-Platform {32-bit | 64-bit | All}]
[-ThrottleLimit <Int32>] [<CommonParameters>]
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.
Required? false
Position? 1
Default value none
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-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.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? true (ByPropertyName)
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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#MSFT_OdbcDsn[]
Example 1: Get all DSNs
PS C:\\> Get-OdbcDsn
This command gets all ODBC User DSNs and System DSNs that use 32-bit or 64-bit ODBC drivers.
Example 2: Get ODBC System DSNs by name
PS C:\\> Get-OdbcDsn -Name "MyPayroll" -DsnType "System" -Platform "32-bit"
This command gets the ODBC System DSNs named MyPayroll stored in the 32-bit registry location.
Example 3: Get ODBC DSNs with names that contain a string
PS C:\\> Get-OdbcDsn -Name "*Payroll*"
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.
Example 4: Get all ODBC User DSNs for specified driver
PS C:\\> $DsnArray = Get-OdbcDsn -DriverName "SQL Server*"
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.
RELATED LINKS
Add-OdbcDsn
Remove-OdbcDsn
Set-OdbcDsn