基本的な展開エージェントを管理する

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 Address を localhost に変更することで、基本的な展開モードに切り替えることができます。

基本的な展開エージェントを使用する

基本的な展開モードでは、PowerShell コマンドを使用してエンドユーザーまたは管理者が手動で録画をトリガーできます。ホットキーまたは動的録画によってトリガーすることもできます。

PowerShell コマンドを使用して録画を開始または停止する

エンドユーザーと管理者の両方が PowerShell コマンドを使用して録画を管理できます。

Session Recording モジュールをインポートする

コマンドを実行する前に、必要なモジュールがインポートされていることを確認してください。

PowerShell を開き、以下を実行してモジュールをインポートします。

Import-Module -DisableNameChecking 'C:\Program Files\Citrix\SessionRecording\Agent\Bin\EndUserInitiatedSRSnapin.dll'

利用可能なコマンド

次の表に、エンドユーザーがトリガーするセッション記録を提供する3つのPowerShellコマンドを 示します。

例 1: エンドユーザーがトリガーする録画

エンドユーザーは、現在の活動中のセッションの録画をトリガーして、操作を動的にキャプチャできます（たとえば、トラブルシューティング目的で）。

ユーザーはセッション内で次の手順を実行できます。

1. セッションデスクトップからPowerShellを起動します。

2. 前のセクションで説明されているように、モジュールをインポートします。
3. Get-SessionRecording Statusコマンドを使用して録画ステータスを確認し、セッションがすでに録画されていないことを確認します。
4. セッションの録画を開始するには、Start-SessionRecordingコマンドを使用します。

5. Get-SessionRecordingStatusコマンドを使用して録画ステータスを確認し、セッションが録画されていることを確認します。ステータスはRecordingである必要があります。

   

6. 問題を再現するか、文書化する必要がある操作を実行します。
7. 操作が完了したら、 Stop-SessionRecordingコマンドを使用して録画を停止します。
8. 録画ファイルを見つけて、その後のトラブルシューティングに進みます。デフォルトでは、保存パスは% USE RPROFILE %\Videos\SessionRecordingsの下にあり、これは基本展開エージェントの設定を構成することでカスタマイズできます。

注:

セッションの継続時間が30分に達するか、ファイルサイズが60 MBに達すると、録画は自動的に停止します。

例2: 管理者による録画トリガー

管理者は、マシン上の特定の有効なセッションの録画をトリガーできます（たとえば、ユーザーのトラブルシューティングを支援するため）。

管理者は、セッションをホストしているマシンで次の手順を実行できます。

1. 管理者としてPowerShellを起動します。
2. 前のセクションで説明されているように、モジュールをインポートします。

3. query session コマンドを使用して、ターゲットユーザーセッションのSessionIDを取得します。 query session | Select-String "Active"

   

4. Get-SessionRecordingStatus -SessionId <SessionID>コマンドを使用して録画ステータスを確認し、セッションがすでに録画されていないことを確認します。 ステータスは以下のように表示されるはずです。

   

5. Start-SessionRecording -SessionId <SessionID>コマンドを使用してセッションの録画を開始します。

6. Get-SessionRecordingStatus -SessionId <SessionID>コマンドを使用して録画ステータスを確認し、セッションが録画中であることを確認します。ステータスはRecordingと表示されるはずです。

7. ユーザーに問題を再現させるか、文書化する必要がある操作を実行するように指示します。
8. 操作が完了したら、Stop-SessionRecording -SessionId <SessionID>を使用して録画を停止します。
9. ターゲットユーザープロファイルの下にある録画ファイルを見つけます（例： C:\Users\user0\Videos\SessionRecordings）。その後、トラブルシューティングを続行します。

ホットキーを使用して録画を開始または停止する

エンドユーザーはショートカットキー（ホットキー）を使用して録画を制御することもできます。デフォルトでは、この機能は無効になっています。

ホットキーを有効にする

ホットキー機能を有効にするには、VDAマシンで次の操作を行います。

Set-SessionRecordingConfiguration -PerMachine -EnableHotkeys $true

このコマンドの実行には、ローカル管理者アカウントが必要です。

この設定はマシンごとに適用され、以降のアクティブなセッションに有効になります。

デフォルトのホットキー

有効にすると、デフォルトのホットキーは次のとおりです。

• 録画を開始するショートカットキー: CTRL + SHIFT + F8
• 録画停止のショートカットキー：CTRL + SHIFT + F9

注:

デフォルトでは、ストレージパスは%USERPROFILE%\Videos\SessionRecordingsの下にあります。これは、基本展開エージェント設定の構成でカスタマイズできます。

セッションの継続時間が30分に達するか、ファイルサイズが60 MBに達すると、録画は自動的に停止します。

ホットキーのカスタマイズ

デフォルトのホットキーが他のアプリケーションと競合する場合は、次のコマンドを使用してカスタマイズできます。

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 セッションにインポートする必要があります。

1. PowerShell を開き、エージェントのインストールフォルダー: <SessionRecordingAgent installation path>\Bin フォルダーに移動します。

   例: cd "C:\Program Files\Citrix\SessionRecording\Agent\Bin\"

2. 以下を実行してモジュールをインポートします。

   import-module -DisableNameChecking.\EndUserInitiatedSRSnapin.dll

   

PowerShell の構成コマンド

次の表に、セッション録画構成を管理するためのPowerShellコマンドを示します。

構成の設定値

基本展開モードで利用可能な設定は次のとおりです。Set-SessionRecordingConfiguration cmdlet を使用してこれらを構成できます。

マシンに構成を適用するには、-PerMachine スイッチパラメーターを追加します。これには管理者権限が必要です。指定した場合、設定はマシンレベルに適用されます。省略した場合、設定はユーザーレベルに適用されます。

注:

これらの設定を複数のレベルでカスタマイズした場合、優先順位はセッション > ユーザー > マシンとなります。

構成設定の例

これらの例は、異なるユーザーがどのように構成を設定し、エージェントが最終的かつ有効な設定をどのように決定するかを示しています。

例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レジストリで構成されているSession Recording Serverの値によって決定されます。

方法1: セッションレコーディングエージェントプロパティを使用する

特定のVDAで手動でモードを切り替えることができます。

1. セッションレコーディングエージェントがインストールされているVDAにログオンします。

2. スタートメニューから、セッションレコーディングエージェントプロパティを選択します。

3. Connectionsタブをクリックします。

4. セッションレコーディングサーバーフィールドの値を変更します。
   1. 基本展開モード: localhostと入力します。
   2. 標準展開モード: セッションレコーディングサーバーのFQDNを入力します。
5. 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ファイルではありません。