基本的な展開エージェントを管理する
Session Recording を使用して、基本的な展開エージェントを管理できます。この機能は、Session Recording を展開するための軽量な方法を提供します。この展開方法を使用すると、Session Recording サーバー、プレーヤー、データベース、コンソールなどのバックエンドコンポーネントを展開することなく、アクティブなセッションを MP4 ファイルに記録するなど、Session Recording の基本的な機能を利用できます。
インストール
セッション記録エージェントは、Citrix Virtual Delivery Agent (VDA) とともにデフォルトでインストールされます。
- 新規インストール: VDA バージョン 2511 以降をインストールまたはアップグレードすると、Session Recording Agent がインストールされ、展開モードで動作します。
- 既存のインストール: Session Recording エージェントがすでにインストールされている場合は、エージェントをバージョン 2511 以降にアップグレードし、Session Recording Agent のプロパティで Session Recording Server アドレスを localhost に変更することで、基本展開モードに切り替えることができます。
基本的な展開エージェントを使用する
基本展開モードでは、Citrix Virtual Desktop Assistant または PowerShell コマンドを使用して、エンドユーザーまたは管理者が手動で録画をトリガーできます。ホットキーまたは動的録画によってトリガーすることもできます。
シトリックス バーチャル デスクトップ アシスタントを使用して録画を開始または停止する
Citrix Virtual Desktop Assistant は、CVAD にデフォルトでインストールされます。これには、顧客がアクティブな仮想デスクトップセッションを手動で記録できる組み込みの Session Recording ページが含まれています。この機能により、顧客はトラブルシューティング、コラボレーション、セッションレビューのために、画面アクティビティを MP4 ビデオクリップとしてキャプチャできます。
詳細については、「Citrix Virtual Desktop Assistant アプリケーション」を参照してください。
PowerShell コマンドを使用して録画を開始または停止する
エンドユーザーと管理者の両方が PowerShell コマンドを使用して録画を管理できます。
セッションレコーディングモジュールをインポートする
コマンドを実行する前に、必要なモジュールがインポートされていることを確認してください。
PowerShellを開き、以下を実行してモジュールをインポートします。
Import-Module -DisableNameChecking 'C:\Program
Files\Citrix\SessionRecording\Agent\Bin\EndUserInitiatedSRSnapin.dll'
利用可能なコマンド
次の表に、エンドユーザーがトリガーするセッション レコーディングを提供する3つのPowerShellコマンドを示します。
| コマンド | 項目の説明 |
|---|---|
| セッション記録を開始 | コマンドが実行されるアクティブなセッションの記録を開始します。特定のセッションを記録するには、-SessionId <ID>パラメーターを使用します（ローカル管理者権限が必要です）。詳細については、Get-Help Start-SessionRecordingを実行してコマンドのオンラインヘルプを参照してください。 |
| セッション記録を停止 | コマンドが実行されるアクティブなセッションの記録を停止します。特定のセッションの記録を停止するには、-SessionId <ID>パラメーターを使用します（ローカル管理者権限が必要です）。注：ユーザーは、自身が開始した記録のみを停止できます。動的またはポリシーベースの記録によってトリガーされた記録を停止することはできません。詳細については、Get-Help Stop-SessionRecordingを実行してコマンドのオンラインヘルプを参照してください。 |
| Get-SessionRecordingStatus | コマンドが実行されるアクティブなセッションの記録ステータスを取得します。特定のセッションのステータスを取得するには、-SessionId <ID>パラメーターを使用します。詳細については、Get-Help Get-SessionRecording Statusを実行してコマンドのオンラインヘルプを参照してください。 |
例1: エンドユーザーがトリガーする録画
エンドユーザーは、現在のアクティブなセッションの録画を動的にトリガーして、操作をキャプチャできます（たとえば、トラブルシューティング目的で）。
ユーザーはセッション内で次の手順を実行できます。
-
セッションデスクトップからPowerShellを起動します。
- 前のセクションで説明されているように、モジュールをインポートします。
- 録画ステータスを確認するには、
Get-SessionRecording Statusコマンドを使用して、セッションがすでに録画されていないことを確認します。 - セッションの録画を開始するには、
Start-SessionRecordingコマンドを使用します。 -
録画ステータスを確認するには、
Get-SessionRecordingStatusコマンドを使用して、セッションが録画されていることを確認します。ステータスは Recording であるはずです。
- 問題を再現するか、文書化する必要がある操作を実行します。
- 操作が完了した後に、
Stop-SessionRecordingコマンドを使用して録画を停止します。 - 録画ファイルを見つけて、その後のトラブルシューティングに進みます。デフォルトでは、保存パスは
% USE RPROFILE %\Videos\SessionRecordingsの下にあり、これは基本展開エージェントの設定を構成することでカスタマイズできます。
注:
セッションの継続時間が 30分 に達するか、ファイルサイズが 60 MB に達すると、録画は自動的に停止します。
例2: 管理者がトリガーする録画
管理者は、マシン上の特定の現在アクティブなセッションの記録をトリガーできます（たとえば、ユーザーのトラブルシューティングを支援するため）。
管理者は、セッションをホストしているマシンで以下の手順を実行できます。
- PowerShell を管理者として起動します。
- 前のセクションで説明されているようにモジュールをインポートします。
-
query sessionコマンドを使用して、ターゲットユーザーセッションの SessionID を取得します。query session | Select-String "Active"
-
Get-SessionRecordingStatus -SessionId <SessionID>コマンドを使用して記録ステータスを確認し、セッションがすでに記録されていないことを確認します。ステータスは以下のように 表示されるはずです。
-
Start-SessionRecording -SessionId <SessionID>コマンドを使用してセッションの記録を開始します。 -
Get-SessionRecordingStatus -SessionId <SessionID>コマンドを使用して記録ステータスを確認し、セッションが記録されていることを確認します。ステータスは Recording と表示されるはずです。 - ユーザーに問題の再現、または文書化する必要がある操作の実行を指示します。
- 操作が完了したら、
Stop-SessionRecording -SessionId <SessionID>を使用して記録を停止します。 - ターゲットユーザープロファイルの下で記録ファイルを見つけます。例:
C:\Users\user0\Videos\SessionRecordings。その後、トラブルシューティングを続行します。
ホットキーを使用して記録を開始または停止する
エンドユーザーは、ショートカットキー（ホットキー）を使用して記録を制御することもできます。デフォルトでは、この機能は無効になっています。
ホットキーを有効にする
ホットキー機能を有効にするには、VDAマシンで次の手順を実行します。
Set-SessionRecordingConfiguration -PerMachine -EnableHotkeys $true
このコマンドを実行するには、ローカル管理者アカウントが必要です。
この設定はマシンごとに適用され、以降のアクティブなセッションに有効になります。
デフォルトのホットキー
有効にすると、デフォルトのホットキーは次のとおりです。
- Start recording: CTRL + SHIFT + F8
- 録画を停止するには、CTRL + SHIFT + F9 を使用します。
注:
デフォルトでは、ストレージパスは
%USERPROFILE%\Videos\SessionRecordingsにあります。これは、基本展開エージェント設定の構成でカスタマイズできます。セッションの継続時間が30分に達するか、ファイルサイズが60MBに達すると、録画は自動的に停止します。
ホットキーをカスタマイズする
デフォルトのホットキーが他のアプリケーションと競合する場合は、次のコマンドを使用してカスタマイズできます。
Set-SessionRecordingConfiguration -PerMachine -StartHotKey <hotkey> -StopHotKey <hotkey>
ホットキーのルール:
- 最後のキーとして使用できるのは、F1～F12 または 大文字 (A～Z) のみです。
- 組み合わせでは、最後のキーのみを定義します。CTRL + SHIFT プレフィックスは必須であり、自動的に適用されます。
例: 開始ホットキーを CTRL + SHIFT + F1 に設定するには、<hotkey> として F1 を入力します。
ダイナミックレコーディングを使用して録画を開始または停止する
ダイナミックセッションレコーディングポリシーを使用して録画をトリガーすることもできます。詳細については、「ダイナミックセッションレコーディング」を参照してください。
注:
デフォルトでは、ストレージパスは
%USERPROFILE%\Videos\SessionRecordingsにあります。これは、基本展開エージェント設定の構成 でカスタマイズできます。セッション期間が 30分 に達するか、ファイルサイズが 60 MB に達すると、録画は自動的に停止します。
基本展開エージェント設定の構成
PowerShellコマンドを使用して、基本展開エージェントの設定をカスタマイズできます。これらの設定は、マシンレベルまたはユーザーレベルで適用されます。
前提条件
設定を構成する前に、必要なモジュールをPowerShellセッションにインポートする必要があります。
-
PowerShellを開き、エージェントのインストールフォルダー:
<SessionRecordingAgent installation path>\Binフォルダーに移動します。例:
cd "C:\Program Files\Citrix\SessionRecording\Agent\Bin\" -
以下を実行してモジュールをインポートします。
import-module -DisableNameChecking.\EndUserInitiatedSRSnapin.dll
PowerShell の構成に関するコマンド
次の表に、セッション記録構成を管理するためのPowerShellコマンドを示します。
| コマンド | 項目説明 |
|---|---|
| Set-SessionRecordingConfiguration | マシンまたはユーザーレベルでセッション記録構成値を設定します。詳細については、Get-Help SetSessionRecordingConfigurationを実行してください。 |
| Get-SessionRecordingConfiguration | 有効なセッション記録構成を取得するか、特定のレジストリスコープ（マシン、ユーザー、またはセッション）から生の値（raw values）を照会します。詳細については、Get-Help GetSessionRecordingConfigurationを実行してください。 |
| Clear-SessionRecordingConfiguration | マシンまたはユーザーレベルのセッション記録構成値をクリアし、マシンレベルまたはデフォルト値に戻します。詳細については、Get-Help ClearSessionRecordingConfigurationを実行してください。 |
設定オプション
基本展開モードで利用可能な設定は以下のとおりです。Set-SessionRecordingConfigurationコマンドレットを使用してこれらを構成できます。
-PerMachineスイッチパラメータを追加して、マシンに構成を適用します。これには管理者権限が必要です。指定した場合、設定はマシンレベルに適用されます。省略した場合、設定はユーザーレベルに適用されます。
| プロパティ | タイプ | 設定 | スコープ | デフォルト | 注 |
|---|---|---|---|---|---|
| -アロウユーザー・トリガー | ブール値 | エンドユーザーによるトリガー録画を許可する | マシン | 真 | ユーザーが手動で録画を開始/停止できるかどうかを制御します |
| -ストレージパス | 文字列 | 録画保存パス | マシン、ユーザー、セッション | %USERPRO FILE%\ビデオ\セッションの記録 | 録画ファイルが保存されるディレクトリです。このディレクトリは、ローカルドライブ、UNCネットワークパス、またはマウントされたドライブに配置できます。 |
| -最大録画時間（分） | Int | 録画の最大継続時間 | マシン、ユーザー、セッション | 30 | この時間（分）が経過すると、セッションは自動的に録画を停止します。 |
| -最大サイズ（メガバイト） | Int | 最大ファイルサイズ | マシン、ユーザー、セッション | 60 | セッションは、このサイズ (MB) に達すると自動的に記録を停止します。 |
| -事前録画の有効化 | ブール値 | 事前記録を有効にする | マシン | フォールス | 記録トリガーの前に事前記録を有効にする。 |
| -プレレコーディングの有効化 | ブール値 | 事前記録を有効にする | マシン | フォールス | 記録トリガーの前に事前記録を有効にする。 |
| -プレレコーディング期間（秒） | 整数 | プリレコーディング期間 | マシン | 30 | プリレコーディングバッファの期間を秒単位で指定します。 |
| -ホットキー有効化 | ブール値 | ホットキーを有効にする | マシン | 無効 | 録画の開始/停止用のホットキーを有効にします |
| -ホットキー開始 | 文字列 | 録画開始ホットキー | マシン | F8 | デフォルトはCTRL + SHIFT + F8に割り当てられています。 |
| -ストップホットキー | 文字列 | 録画停止ホットキー | マシン | F9 | デフォルトはCTRL + SHIFT + F9に割り当てられています。 |
| -スクリーンID | 整数 | 録画する画面ID | マシン、ユーザー、セッション | 0 | すべての画面に0を使用します。 |
注:
これらの設定を複数のレベルでカスタマイズした場合、優先順位はセッション > ユーザー > マシンです。
構成設定の例
これらの例は、異なるユーザーがどのように構成を設定し、エージェントが最終的な有効な設定をどのように決定するかを示しています。
例1：管理者がユーザーによる録画開始を無効にする場合
ローカル管理者（例：LocalAdmin）は、すべての標準ユーザーが手動で録画を開始する機能を無効にするためのマシン全体のポリシーを設定できます。
Set-SessionRecordingConfiguration -PerMachine -AllowUserTrigger $false
説明: このコマンドは管理者権限 (-PerMachine) を必要とし、ユーザーレベルの設定に関係なく、このVDA上のすべてのユーザーが Start-SessionRecording を使用することを防ぎます。
例2：管理者がマシン全体のデフォルトを設定する場合
LocalAdminは、VDA上のすべてのユーザーに対して、デフォルトの保存場所、最大期間、および最大サイズを設定します。
Set-SessionRecordingConfiguration -PerMachine -StoragePath
"D:\SessionRecordings"-MaximumDurationInMinutes 120 -
MaximumSizeInMegabytes 500
説明: これはマシンレベルで構成を設定します。標準ユーザー（例：User0）の場合、録画はD:\SessionRecordingsにデフォルトで保存され、120分または500MBのいずれか早い方で停止します。
例3：標準ユーザーがマシンデフォルトを上書きする場合
標準ユーザー（User0）は、管理者のマシンレベル設定を上書きして、ファイルをローカルのCドライブに保存することを好みます。
Set-SessionRecordingConfiguration -StoragePath
"C:\Users\User0\ SessionRecordings" -MaximumDurationInMinutes 60
説明: このコマンドは -PerMachine スイッチを使用せずに実行されるため、ユーザーレベルで適用されます。ユーザーレベルの設定はマシンレベルの設定よりも優先度が高いため、User0の録画はC:\Users\User0\ SessionRecordingsに保存され、60分後に停止します。
例4：セッション固有の上書き
特定のレコーディング中に、User0はファイルを一時的にネットワーク共有 (\\fileshare\temp) に保存し、期間を15分に制限する必要があります。これはユーザー設定とマシン設定の両方を上書きします。
Start-SessionRecording -StoragePath "\\fileshare\temp" -
MaximumDurationInMinutes 15
説明: Start-SessionRecording に直接渡されるパラメーターは、セッションレベルのオーバーライドを作成します。これは絶対的に最高の優先順位を持ち、その単一のレコーディングインスタンスに対してのみ有効です。次のレコーディングセッションでは、ユーザーまたはマシンの構成に戻ります。
構成のチェック
現在構成されている値と最終的な有効設定を表示するには、Get-SessionRecordingConfiguration コマンドレットを使用します。
Get-SessionRecordingConfiguration
説明: このコマンドは、階層 (セッション > ユーザー > マシン) を適用した結果を示し、コマンドを実行しているユーザーに対して現在使用されている設定を提供します。
構成のクリア
カスタム設定を削除するには、Clear-SessionRecordingConfiguration コマンドレットを使用します。これにより、エージェントは次に優先度の高い構成に戻ることができます。
-
特定のユーザー設定をクリアする:
User0がファイルをC:\Users\User0\SessionRecordingsに保存するのをやめ、カスタム設定をデフォルト設定に戻したい場合、以下を実行します:
Clear-SessionRecordingConfiguration -StoragePath - MaximumDurationInMinutes
説明: これにより、ユーザー スコープから StoragePath と MaximumDurationInMinutes の値がクリアされます。
-
すべてのマシンレベル構成をクリアする (管理者権限が必要):
Clear-SessionRecordingConfiguration -PerMachine -ClearAll
説明: このコマンドには管理者権限 (-PerMachine) が必要で、マシンレベルで設定されたすべてのカスタム構成をクリアします。
エージェントの展開タイプを切り替える
セッション録画エージェントは、2つの異なる展開モードをサポートしています。
- 基本展開モード: これは、バックエンドコンポーネントを展開せずに、アクティブなセッションをMP4ファイルとしてローカルに記録する軽量な方法を提供します。このモードは、セッション録画サーバーのアドレスがlocalhostに設定されている場合にアクティブになります。
- 標準展開モード: これは、エージェントがセッション録画サーバーに接続する従来の集中管理型展開です。このモードは、高いスケーラビリティと高度な機能を提供します。このモードは、セッション録画サーバーのアドレスがサーバーの完全修飾ドメイン名 (FQDN)に設定されている場合にアクティブになります。
動作モードは、セッション録画エージェントのプロパティまたはWindowsレジストリで構成されているセッション録画サーバーの値によって決定されます。
方法1: セッション録画エージェントのプロパティを使用する
特定のVDAで手動でモードを切り替えることができます。
-
セッション録画エージェントがインストールされているVDAにログオンします。
-
スタートメニューから、セッション録画エージェントのプロパティを選択します。
-
接続タブをクリックします。
-
セッション録画サーバーフィールドの値を変更します。
- 基本展開モード: localhostと入力します。
- 標準展開モード: セッション録画サーバーのFQDNを入力します。
- 変更を保存するには、OKをクリックします。
方法2：Windowsレジストリまたはグループポリシーを使用する
大規模な展開の場合、設定はWindowsレジストリで直接構成でき、通常はグループポリシーオブジェクト (GPO) を介して展開されます。
-
レジストリキー：
HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\SmartAuditor\Agent\ -
値の名前：
SmAudServerName -
値のデータ：
- 基本展開モードの場合： 値をlocalhostに設定します。
- 標準展開モードの場合： 値をSession Recording ServerのFQDNに設定します。
注：
モード切り替えの主な考慮事項
-
Session Recordingエージェントは、構成値をセッションの開始時にのみ読み取ります。展開モードへの変更は、VDAで起動された次回の新しいセッションから有効になります。
-
アクティブな、または進行中の録画セッションがある間は、モードを切り替えないことを強くお勧めします。データの一貫性の問題を避けるため、すべてのアクティブな録画が停止するまで待ってください。
録画ファイルの管理
Session Recordingには、録画ファイルを管理するためのローカルツールSRAgentTool.exeが用意されています。このツールには次の機能があります。
-
破損したMP4録画の回復：予期しないグラフィックプロセスの中断など、異常な状況により再生できないMP4ファイルを修復します。
-
MP4録画の整合性の検証：録画ファイルが改ざんされていないかを確認し、その信頼性を保証します。
以下のディレクトリでツールにアクセスできます: Session RecordingAgent installation path>\Bin.
使用方法の表示
ツールのヘルプ情報と使用方法を表示するには、PowerShellまたはコマンドプロンプトで次のコマンドを実行します:
.\SRAgentTool.exe --help
または
.\SRAgentTool.exe -h
破損した録画を回復する
録画ファイルが再生できない場合は、回復コマンドを使用して修復を試みます。 コマンド:
.\SRAgentTool.exe --recover <path_to_mp4>
出力:
-
成功: ツールは「Recover success」と表示し、新しく回復されたファイル（通常、_recover.mp4というサフィックスが付いています）のパスを示します。
-
回復不要: ファイルが既に再生可能な場合、ツールは「The file can play normally」と表示し、回復は不要です。
録画の整合性を検証する
録画ファイルが改ざんされていないことを確認するには、検証コマンドを使用してそのSHA512署名をチェックします。
コマンド: .\SRAgentTool.exe --valid <path_to_mp4>
出力:
-
有効: sha512署名が正常に一致します。
-
改ざん済み: sha512署名が一致しません。
-
無効なファイル: ファイルが有効なmp4ファイルではありません。
