Windows Server 2012のWDACで使用できるPowerShellコマンドレット (Get-OdbcDsn) について

スポンサーリンク

Windows Server 2012では、Windows Server 2008 R2からActive Directory (AD)やフェールオーバー クラスタリング (WSFC) といったサーバー管理におけるPowerShellコマンドレットが強化、および追加されました。

各役割および機能に関するPowerShellコマンドレットのヘルプについて、オンライン上で公開されていますが、現時点では主に英語のみで日本語の情報はあまり公開されていないようです。

ここでは、Windows Server 2012のWindowsデータ アクセス コンポーネント (WDAC)に関するPowerShellコマンドレットの情報について、日本語としてオンライン上で備忘録として確認したいと思い、本ブログ上で纏めてみました (内容については「Get-Help」コマンドレットの-Fullオプションを用いて実行した結果を編集、補足したものとなります)。

この記事では、「Get-OdbcDsn」コマンドレットについて記載します (他のコマンドレットについては、「Windows Server 2012のWDACで使用できるPowerShellコマンドレットについて」を参照)。

■名前

Get-OdbcDsn

■概要

-Name、-DsnType、-Platformおよび-DriverNameパラメーターをとおして値にマッチする、システム上にインストールされた1つ、もしくは複数のODBCデータソース名 (DSN)を取得します。-Name、もしくは-DriverNameパラメーターが指定されていない場合、既定では、それぞれすべてのDSN名とすべてのドライバ名にマッチすることとなっています。パラメーターが指定されていない場合、システム上のすべてのODBC DSNを取得します。

■構文

Get-OdbcDsn [[-Name] <string>] [-DriverName <string>]
     [-Platform <string> {32-bit | 64-bit | All}] [-DsnType <string> {User | System | All}]
     [-CimSession <CimSession[]>] [-ThrottleLimit <int>] [-AsJob] 
     [<CommonParameters>]

■説明

ODBC、データソース名およびドライバに関する詳細な情報については、Microsoft Open Database Connectivity (ODBC)Data Sources、もしくはDriversを参照してください。

■パラメーター

-AsJob
バックグラウンド ジョブとして、コマンドレットを実行します。完了するまでに長時間要するコマンドを実行する場合、このパラメーターを使用します。 コマンドレットは、ジョブとして扱われるオブジェクトを返し、コマンドプロンプト上に表示します。ジョブが完了する間、セッション中で実行し続けることが可能です。ジョブを管理するために、*-Jobコマンドレットを使用済ます。ジョブの結果を得るためには、Receive-Jobコマンドレットを使用します。Windows PowerShellバックグランド ジョブに関する詳細な情報は、about_Jobsを参照してください。

エイリアスなし
必須false
位置named
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-CimSession <CimSession[]>
リモート セッション内、もしくはリモート コンピューター上でコマンドレットを実行します。New-CimSessionコマンドレット、もしくはGet-CimSessionコマンドレットの出力のようなコンピューター名、もしくはセッション オブジェクトをに入力します。 既定ではローカル コンピューター上のカレント セッションとなります。

エイリアスなし
必須false
位置named
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-DriverName <string>
指定したODBCドライバーが使用しているODBC DSNのみを取得します。ワイルドカードを使用することが可能です。既定ではすべてのODBC DSNを返します。

エイリアスなし
必須false
位置named
既定値なし
パイプライン入力を許可するtrue (ByPropertyName)
ワイルドカード文字を許可するtrue

-DsnType <string>
ODBC DSNの型を取得します。指定可能な値は、「User」、「System」、および「All」です。

エイリアスなし
必須false
位置named
既定値なし
パイプライン入力を許可するtrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-Name <string>
DSN名による1つ、もしくは複数のODBC DSNを指定します。ワイルドカードを使用することが可能です。既定では、すべてのODBC DSNを返します。

エイリアスなし
必須false
位置1
既定値なし
パイプライン入力を許可するtrue (ByPropertyName)
ワイルドカード文字を許可するtrue

-Platform <string>
取得するODBC DSNのプラットフォーム アーキテクチャを指定します。 指定可能な値は、「32-bit」、「64-bit」、および「All」です。 このコマンドがリモートCIMセッションで実行されるならば、これはリモート マシンのプラットフォーム アーキテクチャです。

エイリアスなし
必須false
位置named
既定値なし
パイプライン入力を許可するtrue (ByPropertyName)
ワイルドカード文字を許可するfalse

-ThrottleLimit<Int32>
コマンドレットを実行するために設定することができる並列実行の最大数を指定します。このパラメータが省略される、もしくは値に0が入力される場合、Windows PowerShellは、コンピューター上で動作しているCIMコマンドレットの数に基づいて、コマンドレットに対する最適のスロットル制限を計算します。スロットル制限は、現在のコマンドレットのみに適用され、セッションもしくはコンピューターには適用されません。

エイリアスなし
必須false
位置named
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose-Debug-ErrorAction-ErrorVariable-WarningAction-WarningVariable-OutBuffer、および-OutVariable。詳細については、「about_commonparameters」と入力してヘルプを参照してください。

■入力

System.String

■出力

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

■エイリアス

なし

■メモ

このコマンドレットを含むモジュールのヘルプ ファイルをダウンロードしてインストールするには、Update-Helpを使用してください。

■例

例1

 Get-OdbcDsn 

例1:説明

このコマンドは、32ビットおよび64ビットODBCドライバーを使用しているすべてのユーザーDSN、およびシステムDSNを取得します。

例2

 Get-OdbcDsn &quot;MyPayroll&quot; -DsnType System -Platform 32-bit 

例2:説明

このコマンドは、32ビットレジストリ位置に格納された「MyPayroll」という名前のODBCシステムDSNを取得します。-Nameパラメーターの位置は1 (一番最初)です。

例3

 Get-OdbcDsn -Name &quot;*Payroll*&quot; 

例3:説明

このコマンドは、ネイティブ レジストリ ハイブ位置に格納されている、かつワイルドカードにマッチした名前のODBCユーザーDSN、およびシステムDSNを取得します。

例4

 $dsnArray = Get-OdbcDsn -DriverName &quot;SQL Server*&quot; 

例4:説明

このコマンドは、ワイルドカードにマッチする名前のドライバーを使用しているすべてのODBCユーザーDSNを取得します。将来使用するために、PowerShell変数に結果を格納します。

■関連するリンク

  • Add-OdbcDsn
  • Remove-OdbcDsn
  • Set-OdbcDsn
  • Wdac

[参考]