スクリプトタスク

最終公開日 : Nov 13, 2026
Related information
管理 (Webコンソール)

はじめに

ヒント:
スクリプトタスクはマシンレベルで動作します。ユーザーセッションレベルでタスクを実行するには、代わりに外部タスクを使用します。
このページでは、独自の環境管理ニーズに合わせてカスタマイズしたスクリプトタスクを追加できます。その後、Workspace Environment Management™ (WEM) で、該当する構成セットでそれらのタスクを構成することにより、自動化できます。
現在、以下の組み込みスクリプトタスクをご利用いただけます。

クラウドヘルスチェック

Virtual Delivery Agent (VDA) の健全性を測定するチェックを実行できます。VDAヘルスチェックは、一般的なVDA登録およびセッション起動の問題の考えられる原因を特定します。クラウドヘルスチェックは、エージェントホスト上のローカルシステムアカウントで実行されます。

Windowsサービス管理

Windowsサービス管理は、1つ以上のWindowsサービスの開始、停止、再起動、構成など、Windowsサービスに関する頻繁に使用される機能を提供します。

Windowsサービスの再起動

このスクリプトは、Windowsサービスのステータスをチェックします。サービスが現在実行されておらず、ForceStartパラメーターが指定されている場合、スクリプトはサービスを開始します。現在の状態にかかわらず、サービスが実行中で強制的な開始を必要としない場合、最新の構成で動作していることを確認するため、または停止状態から回復するために再起動されます。
パラメーター
名前 タイプ デフォルト 必須 注
ServiceNames 文字列 BrokerAgent 偽 管理するサービスの名前を指定します。指定しない場合、BrokerAgent がデフォルトになります。複数のサービスを入力する必要がある場合は、サービス名をコンマで区切ります。すべてのスペースはトリミングされます。例: ServiceA, ServiceB。
ForceStart ブール値 真 偽 サービスが実行されていないと判断された場合に、サービスを開始するかどうかを示します。実行中のサービスには影響しません。実行中のサービスは、メンテナンスまたは回復の目的で常に再起動されます。

Windows サービスの停止

このスクリプトは、指定されたWindowsサービスの一覧を停止します。スクリプトは、各サービスがインストールされているかを確認し、サービスを強制的に停止しようとします。その後、スクリプトはサービスが正常に停止したかどうかを確認し、ステータスを報告します。
パラメーター
名前 タイプ デフォルト 必須 注
ServiceNames 文字列 BrokerAgent 偽 管理するサービスの名前を指定します。指定しない場合、BrokerAgent がデフォルト値となります。複数のサービスを入力する必要がある場合は、サービス名をコンマで区切ってください。すべてのスペースはトリミングされます。例: ServiceA, ServiceB。

Windowsサービスを構成する

このスクリプトは、起動タイプや回復アクションを含むWindowsサービスの設定を調整します。
パラメーター
名前 タイプ デフォルト 必須 注
ServiceNames 文字列 なし 真 管理するサービスの名前を指定します。指定しない場合、BrokerAgent がデフォルト値となります。複数のサービスを入力する必要がある場合は、サービス名をコンマで区切ってください。すべてのスペースはトリミングされます。例: ServiceA, SerivceB。
StartupType 文字列 ヌル 偽 サービスのスタートアップの種類を設定します。有効なオプションは、Automatic、Manual、またはDisabledです。
FirstFailureAction 文字列 ヌル 偽 最初の障害に対するアクションを定義します。例: restart/none。
SecondFailureAction 文字列 ヌル 偽 2 回目の連続した障害に対するアクションを定義します。
SubsequentFailureAction 文字列 ヌル 偽 2 回目以降のすべての連続した障害に対するアクションを定義します。

サーバーの再起動

マシンの再起動

このスクリプトは、オプションの遅延と強制オプションを使用してローカルマシンを再起動します。
パラメーター
名前 タイプ デフォルト 必須 注
Force ブール値 真 いいえ 指定した場合、未保存のデータやアクティブなユーザーセッションを無視して、即座に再起動を強制します。
Delay 整数 10 いいえ コンピュータが再起動されるまでの遅延を秒単位で指定します。3秒から30秒の間である必要があります。デフォルトは10秒です。

CDFトレース管理

CDFトレースの開始

このスクリプトは、CTLファイルまたはCTLファイルの事前定義されたカテゴリを入力として受け取り、CDFツールプロセスを開始し、CTLファイル内のモデルのトレースを開始します。
パラメーター
名前 タイプ デフォルト 必須 注
traceOutputPath 文字列 C:\ProgramData\Citrix\WEM\CDFLogs いいえ CDFレポートの出力パスを指定します。
category 文字列 all いいえ
トレースを開始するための事前定義されたカテゴリを指定します。サポートされている値は次のとおりです。
  • all
  • always on tracing
  • desktop Server os vda
  • delivery controller
  • federated authentication service
  • provisioning service
  • universal print server
  • citrix director
  • citrix studio
  • session recording administration
  • session recording player
  • citrix workspace app for windows
ctlFilePath 文字列 ヌル フォールス トレースを開始するctlファイルを指定します。

CDFトレースの停止

このスクリプトは、CDFツールのトレースを停止します。

CDFログのクリーンアップ

ストレージ消費を節約するために、CDFトレースログをクリーンアップすることは有用です。指定されたディレクトリ下のCDFファイルを削除する機能を提供する必要があります。
名前 タイプ デフォルト 必須 注
FileAgeDays 整数 3 偽 日単位での経過時間しきい値を指定します。この値よりも古いファイルとフォルダーは削除されます。デフォルト値は3日であり、このパラメーターはオプションです。FileAgeDaysが1日未満の場合、すべてのファイルまたはディレクトリが削除されます。
ヒント:
  • カスタムスクリプトタスクと組み込みスクリプトタスクを区別できます。カスタムタスクには「CUSTOM」ラベルが付けられ、組み込みタスクには「CITRIX」ラベルが付けられます。
  • 組み込みスクリプトタスクは常にカスタムタスクの上に表示されます。カスタムスクリプトタスクは、最終変更時刻に基づいて降順にソートされます。
この機能を使用すると、独自の管理ニーズに合わせてWEMの機能を拡張できます。たとえば、組み込みスクリプトタスクのCloud Health Checkを使用すると、VDAの健全性を測定できます。このタスクはスクリプトベースです。独自のスクリプトファイルを作成できます。その後、そのスクリプトファイルをWEMにスクリプトタスクとして追加することで、WEMを使用してタスクを自動化できます。
スクリプトタスクが実行されるたびに、対応するレポートが生成されます。レポートには、タスクの実行日時、タスクの実行結果などの情報が含まれており、タスクに関連するアクティビティを監査する機能を提供します。
スクリプトタスクは構成セットレベルで機能します。スクリプトタスクを使用するための一般的なワークフローは次のとおりです。
  1. スクリプトタスクページで、スクリプトタスクを追加します。
  2. スクリプトタスクを有効にする構成セットに移動します。
  3. その構成セットのスクリプトタスク設定ページで、スクリプトタスクを有効にします。スクリプトタスク設定を参照してください。
  4. 必要に応じて、スクリプトタスクに関連するレポートを表示します。これには2つの方法があります。
    • 監視 > レポートに移動し、そこでレポートを表示します。
    • スクリプトタスクまたは構成セットのスクリプトタスク設定ページに移動します。スクリプトタスクを見つけ、省略記号を選択し、レポートの表示を選択します。すると、関連するフィルターが自動的に適用された監視 > レポートページに移動します。そこで関連レポートを確認できます。
スクリプトタスクレポートの詳細については、レポートを参照してください。

スクリプトタスクを追加する

スクリプトタスクを追加するには、次の手順を実行します。
  1. スクリプトタスクページで、スクリプトタスクの追加をクリックします。
  2. スクリプトタスクの追加ウィザードで、次の設定を構成し、保存をクリックします。
    • タスク名。タスクの名前を指定します。
    • タグ。既存のタグから選択するか、コンマで区切ってタグを入力します。タグは20文字以内である必要があります。タグはキーワードやラベルのようなものです。タグを使用すると、新しい方法でタスクを識別できます。また、フィルターとして機能し、重要な基準に応じてスクリプトタスクでのタスクの表示を再配置できます。タグはいくつでも使用できます。
    • 説明。必要に応じて、タスクを識別するのに役立つ追加情報を指定します。
    • ファイルの種類。タスクのファイルの種類を選択します。次の2種類のファイルがサポートされています。
      • PowerShell。個別のPowerShellスクリプトファイル。
      • ZIP。複数のファイルを1つのzipファイルにバンドルします。10 MBを超えるzipファイルはサポートされていません。zipファイルをアップロードした後、スクリプトタスクの開始時に実行するファイルを示すエントリポイントを指定します。エントリポイントファイルは、フォルダ構造内で3階層より深くならないようにしてください。
    • ファイルのアップロード。参照をクリックし、ファイルに移動して選択し、開くをクリックします。スクリプトタスクの追加ウィザードに戻ります。
    • 権限の付与。スクリプトタスクに付与するアクセスレベルを指定します。各オプションに関連付けられている権限を理解していることを確認してください。
      • フルアクセス。フルアクセスが割り当てられたスクリプトタスクは、広範なローカルアクセス権を持ちます。選択した場合、スクリプトタスクはローカルシステムアカウントで実行されるかのように権限が付与されます。
      • 制限付きアクセス（ネットワークアクセスあり）。制限付きアクセス（ネットワークアクセスあり）が割り当てられたスクリプトタスクは、広範なローカルアクセス権を持ちませんが、ネットワークリソースにアクセスできます。選択した場合、スクリプトタスクはネットワークサービスアカウントで実行されるかのように権限が付与されます。
      • 制限付きアクセス（ネットワークアクセスなし）。制限付きアクセス（ネットワークアクセスなし）が割り当てられたスクリプトタスクは、広範なローカルアクセス権を持たず、ネットワークリソースにアクセスできません。選択した場合、スクリプトタスクはローカルサービスアカウントで実行されるかのように権限が付与されます。
      詳細については、Microsoftのドキュメント<https://docs.microsoft.com/ja-jp/windows/security/identity-protection/access-control/security-identifiers#well-known-sids>を参照してください。
  • 作業フォルダ。オプションで、エンドユーザーのオペレーティングシステム上のローカルフォルダの絶対パスを入力します。作業フォルダは、ファイルが開始するときの現在のフォルダです。環境変数（例: %ProgramFiles%）を使用してパスを構築できます。指定しない場合、PSScriptRootがデフォルトの作業フォルダとして使用されます。PSScriptRootの詳細については、Microsoftのドキュメント<https://docs.microsoft.com/ja-jp/powershell/module/microsoft.powershell.core/about/about_automatic_variables?view=powershell-7.1>を参照してください。
  • このタスクは出力ファイルを生成しますか。追加するタスクが出力ファイルを生成するかどうかを選択します。
  • 出力パス。ファイルが存在するフォルダからの相対パスを入力します。パスにはファイル名とファイル名拡張子を含める必要があります。例: output\report.txt。

スクリプトタスクの編集

スクリプトタスクを編集するには、次の手順を実行します。
  1. スクリプトタスクページで、タスクを見つけます。必要に応じて、検索ボックスを使用してタスクをすばやく検索します。
  2. タスクの省略記号をクリックし、タスクの編集を選択します。スクリプトタスクの編集ウィザードが表示されます。
  3. タスク情報タブで、必要に応じて設定を構成します。
  4. 「スクリプトコンテンツ」タブで、スクリプトコンテンツを表示します。
  5. 「保存」をクリックします。
注:
組み込みのスクリプトタスクは編集できません。

スクリプトタスクを削除する

スクリプトタスクを削除するには、次の手順を実行します。
  1. 「スクリプトタスク」ページで、タスクを見つけます。必要に応じて、検索ボックスを使用してタスクをすばやく検索します。
  2. タスクの省略記号をクリックし、「タスクの削除」を選択します。
重要：
  • 組み込みのスクリプトタスクは削除できません。
  • 現在、一部の構成セットで有効になっているスクリプトタスクを削除するには、まずそれらの構成セットで無効にします。

スクリプトタスクをクローンする

スクリプトタスクをクローンするには、次の手順を実行します。
  1. 「スクリプトタスク」ページで、タスクを見つけます。必要に応じて、検索ボックスまたはタグを使用してタスクをすばやく見つけます。
  2. タスクの省略記号をクリックし、「タスクのクローン」を選択します。
注:
タスクをクローンする際、重複する名前を避けるために名前の変更を求められます。

タスク設定オプションを構成する

タスク設定にすばやくアクセスするには、次の手順を実行します。
  1. スクリプトタスクページで、タスクを見つけます。必要に応じて、検索ボックスまたはタグを使用してタスクをすばやく見つけます。
  2. タスクの省略記号をクリックし、タスク設定の構成を選択します。
  3. 構成セットの選択ウィザードで構成セットを選択します。
  4. Goをクリックして、スクリプトタスク設定ページでフィルタリングされたタスクに移動します。そこでは、選択したタスクのみがフィルタリングされて表示されます。

詳細情報

スクリプトタスクの使用例については、以下を参照してください。