SSMA コンソールのコマンドラインオプション (AccessToSQL)

[アーティクル]
05/23/2023

Microsoft では、SSMA アクティビティを実行および制御するための堅牢なコマンドラインオプションのセットを提供しています。以降のセクションでは、こうした機能について詳しく説明します。

SSMA コンソールのコマンドラインオプション

ここでは、コンソールコマンドオプションについて説明します。

このセクションでは、"オプション" という用語を "スイッチ" とも呼びます。

オプションでは大文字と小文字が区別されず、"-" または "/" の文字で始まる場合があります。

オプションが指定されている場合は、対応するオプションパラメーターを指定することが必須です。

オプションパラメーターは、オプション文字と空白で区切る必要があります。

構文の例:

C:\> SSMAforAccessConsole.EXE -s scriptfile

C:\> SSMAforAccessConsole.EXE -s "C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\AssessmentReportGenerationSample.xml" -v "C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\VariableValueFileSample.xml" -c "C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\ServersConnectionFileSample.xml"

スペースを含むフォルダー名またはファイル名は、二重引用符で指定する必要があります。

コマンドラインエントリとエラーメッセージの出力は、STDOUT または指定されたファイルに格納されます。

スクリプトファイルオプション: -s/script

必須スイッチであるスクリプトファイルのパス/名前は、SSMA によって実行されるコマンドシーケンスのスクリプトを指定します。

構文の例:

C:\>SSMAforAccessConsole.EXE -s "C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\ConversionAndDataMigrationSample.xml"

変数値ファイルオプション: -v/variable

この変数値ファイルは、スクリプトファイルで使用される変数で構成されます。スイッチは省略可能です。変数が変数ファイルで宣言されておらず、スクリプトファイルで使用されている場合、アプリケーションはエラーを生成し、コンソールの実行を終了します。

構文の例:

複数の変数値ファイルで定義された変数 (既定値を持つ変数と、該当する場合はインスタンス固有の値を持つ変数)。コマンドライン引数で指定された最後の変数ファイルは、変数が重複している場合に備えて、ユーザー設定を受け取ります。

C:\>SSMAforAccessConsole.EXE -s

"C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\ConversionAndDataMigrationSample.xml" -v c:\migration

projects\global_variablevaluefile.xml -v "c:\migrationprojects\instance_variablevaluefile.xml"

サーバー接続ファイルオプション: -c/serverconnection

このファイルには、各サーバーのサーバー接続情報が含まれています。各サーバー定義は、一意のサーバー ID で識別されます。サーバー ID は、接続関連コマンドのスクリプトファイルで参照されます。

サーバー定義は、サーバー接続ファイルまたはスクリプトファイルの一部にすることができます。サーバー ID が重複している場合は、スクリプトファイル内のサーバー ID がサーバー接続ファイルよりも優先されます。

構文の例:

サーバー ID がスクリプトファイルで使用されます。これらは別のサーバー接続ファイルで定義されています。このファイルでは、変数値ファイルで定義されている変数が使用されます。

C:\>SSMAforAccessConsole.EXE -s "C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\ConversionAndDataMigrationSample.xml" -v

c:\SsmaProjects\myvaluefile1.xml -c

c:\SsmaProjects\myserverconnectionsfile1.xml
サーバー定義はスクリプトファイルに埋め込まれています。

C:\>SSMAforAccessConsole.EXE -s "C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\ConversionAndDataMigrationSample.xml"

XML 出力オプション: -x/xmloutput [xmloutputfile]

このコマンドは、コマンド出力メッセージを xml 形式でコンソールまたは xml ファイルに出力するために使用されます。

xmloutput には、次の 2 つのオプションがあります。

xmloutput スイッチの後にファイルパスが指定されている場合、出力はファイルにリダイレクトされます。

構文の例:

C:\>SSMAforAccessConsole.EXE -s

"C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\ConversionAndDataMigrationSample.xml" -x d:\xmloutput\project1output.xml
xmloutput スイッチの後にファイルパスが指定されていない場合は、コンソール自体に xmlout が表示されます。

構文の例:

C:\>SSMAforAccessConsole.EXE -s "C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\ConversionAndDataMigrationSample.xml" -xmloutput

ログファイルオプション: -l/log

コンソールアプリケーションのすべての SSMA 操作がログファイルに記録されます。なお、スイッチは省略可能です。ログファイルとそのパスがコマンドラインで指定されている場合、ログは指定された場所に生成されます。それ以外の場合は、既定の場所に生成されます。

構文の例:

C:\>SSMAforAccessConsole.EXE

"C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\ConversionAndDataMigrationSample.xml" -l c:\SsmaProjects\migration1.log

プロジェクト環境フォルダーオプション: -e/projectenvironment

このオプションのスイッチは、現在の SSMA プロジェクトのプロジェクト環境設定フォルダーを表します。

構文の例:

C:\>SSMAforAccessConsole.EXE -s

"C:\Program Files\Microsoft SQL Server Migration Assistant for Access\Sample Console Scripts\ConversionAndDataMigrationSample.xml" -e c:\SsmaProjects\CommonEnvironment

セキュリティで保護されたパスワードオプション: -p/securepassword

このオプションは、サーバー接続の暗号化されたパスワードを示します。このオプションは、スクリプトを実行や移行関連のアクティビティと関連せず、移行プロジェクトで使用されるサーバー接続のパスワード暗号化を管理するのに役立つという点で、他のすべてのオプションとは異なります。

他のオプションまたはパスワードをコマンドラインパラメーターとして入力することはできません。それ以外の場合は、エラーが発生します。詳細については、「パスワードの管理」セクションを参照してください。

-p/securepassword に対して、次のサブオプションがサポートされています。

指定したサーバー ID またはサーバー接続ファイルで定義されているすべてのサーバー ID の保護されたストレージにパスワードを追加するか、既存のパスワードを更新するには:

-p|-securepassword -a|add {"<server_id>[, .n]"|all}``-c|-serverconnection <server-connection-file> [-v|variable <variable-value-file>]``[-o|overwrite]

-p|-securepassword -a|add {"<server_id>[, .n]"|all}``-s|-script <server-connection-file> [-v|variable <variable-value-file>] [-o|overwrite]
指定したサーバー ID またはすべてのサーバー ID の保護されたストレージから暗号化されたパスワードを削除するには:

-p/securepassword -r/remove {<server_id> [, ...n] | all}
パスワードが暗号化されているサーバー ID のリストを表示するには:

-p/securepassword -l/list
保護されたストレージに格納されているパスワードを暗号化されたファイルにエクスポートします。このファイルは、ユーザー指定のパスフレーズで暗号化されます。

-p/securepassword -e/export {<server-id> [, ...n] | all} <encrypted-password -file>
以前にエクスポートされた暗号化ファイルは、ユーザー指定のパスフレーズを使用してローカル保護ストレージにインポートされます。ファイルが暗号化解除されると、新しいファイルに格納され、ローカルコンピューター上で暗号化されます。

-p/securepassword -i/import {<server-id> [, ...n] | all} <encrypted-password -file>

コンマ区切り記号を使用して、複数のサーバー ID を指定できます。

ヘルプオプション: -?/Help

SSMA コンソールオプションの構文の概要を表示します。

C:\>SSMAforAccessConsole.EXE -?

SSMA コンソールのコマンドラインオプションの表形式の表示については、「付録 1 (AccessToSQL)」を参照してください。

SecurePassword ヘルプオプション: -securepassword -?/Help

SSMA コンソールオプションの構文の概要を表示します。

C:\>SSMAforAccessConsole.EXE -securepassword -?

SSMA コンソールのコマンドラインオプションの表形式の表示については、「付録 1 (AccessToSQL)」を参照してください。

次のステップ

次の手順は、プロジェクトの要件によって異なります。

パスワードの指定またはパスワードのエクスポート/インポートについては、「パスワードの管理 (AccessToSQL)」を参照してください。
レポートの生成については、「レポートの生成 (AccessToSQL)」を参照してください。
コンソールでの問題のトラブルシューティングについては、「トラブルシューティング (AccessToSQL)」を参照してください。

SSMA コンソールのコマンドラインオプション (AccessToSQL)