RS.exe ユーティリティ (SSRS)

rs.exe ユーティリティは入力ファイル内に指定したスクリプトを処理します。 このユーティリティを使用して、レポート サーバーの配置と管理タスクを自動化します。

Note

SQL Server 2008 R2 (10.50.x) 以降では、rs ユーティリティは、SharePoint 統合モード用に構成されているレポート サーバー、およびネイティブ モードで構成されているレポート サーバーで使用できます。 以前のバージョンでは、ネイティブ モードの構成のみがサポートされていました。

構文

  
rs {-?}  
{-i input_file}  
{-s serverURL}  
{-u username}  
{-p password}  
{-e endpoint}  
{-l time_out}  
{-b batchmode}  
{-v globalvars=}  
{-t trace}  

ファイルの場所

RS.exe は、レポート サーバーのバージョンに応じて、次のフォルダーにあります。 このユーティリティは、ファイル システム上の任意のフォルダーから実行できます。

適用対象: SQL Server Reporting Services (2016)

C:\Program Files (x86)\Microsoft SQL Server\130\Tools\Binn  

適用対象: SQL Server Reporting Services (2017 以降)

C:\Program Files\Microsoft SQL Server Reporting Services\Shared Tools

適用対象: Power BI Report Server

C:\Program Files\Microsoft Power BI Report Server\Shared Tools

引数

-?
(省略可) rs の引数の構文を表示します。

-iinput_file
(必須) 実行する .rss ファイルを指定します。 この値は、.rss ファイルへの相対パスまたは完全修飾パスになります。

-sserverURL
(必須) Web サーバー名とレポート サーバーの仮想ディレクトリ名を指定して、対象ファイルを実行します。 レポート サーバーの URL は、 https://examplewebserver/reportserverのように指定します。 サーバー名の先頭のプレフィックス http:// または https:// は省略可能です。 プレフィックスを省略した場合、レポート サーバーのスクリプト ホストは、まず https の使用を試み、https が使用できない場合は、http を使用します。

-u [domain\]username
(省略可) レポート サーバーへの接続に使用するユーザー アカウントを指定します。 -u および -p を省略した場合、現在の Windows ユーザー アカウントが使用されます。

-ppassword
( -u を指定した場合は必須) -u 引数で使用するパスワードを指定します。 この値は、大文字と小文字が区別されます。

-e
(省略可) スクリプトを実行する SOAP エンドポイントを指定します。 有効な値は次の通りです。

  • Mgmt2010

  • Mgmt2006

  • Mgmt2005

  • Exec2005

値が指定されていない場合は、Mgmt2005 エンドポイントが使用されます。 SOAP エンドポイントの詳細については、「レポート サーバー Web サービス エンドポイント」を参照してください。

-ltime_out
(省略可) サーバーへの接続がタイムアウトするまでの期間を秒数で指定します。既定値は 60 秒です。 タイムアウト値を指定しない場合、既定値が使用されます。 値が 0 の場合は、接続はタイムアウトしません。

-b
(省略可) スクリプト ファイル内のコマンドをバッチで実行します。 いずれかのコマンドが失敗すると、バッチはロールバックされます。 バッチで実行できないコマンドがありますが、それらのコマンドは通常どおり実行されます。 スクリプト内でスローされるが処理されない例外だけが、ロールバックされます。 スクリプトによって例外が処理され、 Mainから正常に値が返された場合、バッチはコミットされます。 このパラメーターを省略した場合、バッチを作成せずにコマンドが実行されます。 詳細については、「Batching メソッド」をご参照ください。

-vglobalvar
(省略可) スクリプト内で使用するグローバル変数を指定します。 スクリプトでグローバル変数を使用する場合は、この引数を指定する必要があります。 .rss ファイルで定義したグローバル変数に対して有効な値を指定する必要があります。 -v 引数ごとに 1 つのグローバル変数を指定できます。

-v 引数はコマンド ラインで指定され、ユーザーのスクリプトに定義されているグローバル変数の値を実行時に設定するために使用されます。 たとえば、スクリプトに parentFolderという名前の変数が含まれている場合、そのフォルダーの名前をコマンド ラインで指定することができます。

rs.exe -i myScriptFile.rss -s https://myServer/reportserver -v parentFolder="Financial Reports"

指定した値に設定された名前を使用して、グローバル変数を作成します。 たとえば、 -v a="1" -v b="2" は、" 1 " の値を持つaという名前の変数と、" 2 " の値を持つbという変数を表します。

グローバル変数は、スクリプト内のすべての関数で使用できます。 円記号と引用符 (\") は、二重引用符と解釈されます。 引用符は、文字列にスペースが含まれている場合のみ必要です。 変数名は、Microsoft Visual Basic で有効である必要があります。 変数名は、アルファベットやアンダースコアで始まり、アルファベット文字、数字、およびアンダースコアを含める必要があります。 予約語は、変数名として使用できません。 グローバル変数の使用の詳細については、「式で使用される組み込みコレクション (レポート ビルダーおよび SSRS)」を参照してください。

-t
(省略可) エラー メッセージをトレース ログに出力します。 この引数は値を取りません。 詳細については、「レポート サーバー サービスのトレース ログ」を参照してください。

アクセス許可

ツールを実行するには、スクリプトの実行対象であるレポート サーバー インスタンスに接続するための権限が必要です。 スクリプトを実行して、ローカル コンピューターまたはリモート コンピューターに変更を加えることができます。 リモート コンピューターにインストールしたレポート サーバーを変更するには、 -s 引数でリモート コンピューターを指定します。

次の例では、実行する Visual Basic .NET スクリプト、および Web サービス メソッドを含むスクリプト ファイルの指定方法を示しています。

rs -i c:\scriptfiles\script_copycontent.rss -s https://localhost/reportserver  

詳細な例については、「レポート サーバー間でコンテンツをコピーするサンプル Reporting Services rs.exe スクリプト」を参照してください。

その他の例については、「Reporting Services スクリプト ファイルを実行する」を参照してください。

解説

スクリプトを定義して、システム プロパティの設定、レポートのパブリッシュなどが行えます。 作成したスクリプトには、 Reporting Services API の任意のメソッドを含めることができます。 使用可能なメソッドおよびプロパティの詳細については、「レポート サーバー Web サービス」を参照してください。

スクリプトは、 Visual Basic .NET のコードで記述し、.rss ファイル名拡張子が付いた Unicode または UTF-8 テキスト ファイルとして保存する必要があります。 rs ユーティリティを使用して、スクリプトをデバッグすることはできません。 スクリプトをデバッグするには、Microsoft Visual Studio 内でコードを実行します。