Get-OdbcDsn

Get-OdbcDsn

Gets ODBC DSNs.

構文

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

詳細説明

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) (https://msdn.microsoft.com/en-us/library/ms710252.aspx), Data Sources (https://msdn.microsoft.com/en-us/library/ms711688.aspx), and Drivers (https://msdn.microsoft.com/en-us/library/ms711688.aspx) on the Microsoft Developer Network.

パラメーター

-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.

エイリアス

なし

必須?

false

位置は?

1

既定値

なし

パイプライン入力を許可する

true (ByPropertyName)

ワイルドカード文字を許可する

true

-DsnType<String>

Specifies the type of an ODBC DSN. This cmdlet gets DSNs of the type that this parameter specifies. このパラメーターに対して使用できる値:

-- User
-- System
-- All

The default value is All.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

true (ByPropertyName)

ワイルドカード文字を許可する

false

-Platform<String>

Specifies the platform architecture. This cmdlet gets the ODBC DSN that belong to the architecture that this parameter specifies. このパラメーターに対して使用できる値:

-- 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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

true (ByPropertyName)

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

true (ByPropertyName)

ワイルドカード文字を許可する

true

-AsJob

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-CimSession<CimSession>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_OdbcDsn[]

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*"

関連トピック

Add-OdbcDsn

Remove-OdbcDsn

Set-OdbcDsn

N:Wdac