Workspace Environment Management

スクリプト化されたタスク

September 12, 2024

寄稿者:

はじめに

ヒント：

スクリプト化されたタスクはマシンレベルで機能します。ユーザーセッションレベルでタスクを実行するには、代わりに外部タスクを使用してください。

このページでは、独自の環境管理ニーズに合わせてカスタマイズしたスクリプト化されたタスクを追加できます。その後、Workspace Environment Management (WEM) で該当する構成セットで構成することで、これらのタスクを自動化できます。

現在、次の組み込みスクリプトタスクが用意されています：

Cloud Health Check
Windowsサービス管理
サーバー再起動
CDFトレーシング管理

Cloud Health Check

仮想配信エージェント (VDA) の正常性を測定するチェックを実行できます。VDAのヘルスチェックは、一般的なVDA登録およびセッションの起動の問題を引き起こす原因となるものを見つけ出します。Cloud Health Check は、エージェントホストのローカルシステムアカウントで実行されます。

Windowsサービス管理

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

Windows サービスを再起動する

このスクリプトは Windows サービスの状態をチェックします。サービスが現在実行されておらず、ForceStartパラメーターが指定されている場合、スクリプトはサービスを開始します。現在の状態に関係なく、サービスが実行中で強制的に起動する必要がない場合は、サービスが再起動されて最新の構成で動作していることを確認するか、停止状態から回復します。

パラメーター

name	type	デフォルト	必須	注
`ServiceNames`	string	ブローカーエージェント	False	管理するサービスの名前を指定します。指定しない場合、デフォルトは`BrokerAgent`になります。複数のサービスを入力する必要がある場合は、サービス名をカンマで区切ります。すべてのスペースがトリミングされます。たとえば、サービスA、サービスB。
`ForceStart`	ブーリアン型	true	False	サービスが実行されていないことが判明した場合に、サービスを開始するかどうかを示します。実行中のサービスには影響しません。実行中のサービスは、メンテナンスまたはリカバリの目的で常に再起動されます。

Windows サービスを停止する

このスクリプトは、指定された Windows サービスのリストを停止します。スクリプトは、各サービスがインストールされているかどうかを確認し、サービスを強制停止しようとします。次に、スクリプトはサービスが正常に停止したかどうかを確認し、ステータスを報告します。

パラメーター

name	type	デフォルト	必須	注
`ServiceNames`	string	ブローカーエージェント	False	管理するサービスの名前を指定します。指定しない場合、デフォルトは`BrokerAgent`になります。複数のサービスを入力する必要がある場合は、サービス名をカンマで区切ります。すべてのスペースがトリミングされます。たとえば、サービスA、サービスB。

Windows サービスの設定

このスクリプトは、スタートアップの種類や回復アクションなど、Windows サービスの構成を調整します。

パラメーター

name	type	デフォルト	必須	注
`ServiceNames`	string	Null	true	管理するサービスの名前を指定します。指定しない場合、デフォルトは`BrokerAgent`になります。複数のサービスを入力する必要がある場合は、サービス名をカンマで区切ります。すべてのスペースがトリミングされます。たとえば、サービスA、サービスB。
`StartupType`	string	Null	False	サービスのスタートアップタイプを設定します。有効なオプションは [自動]、[手動]、または [無効] です。
`FirstFailureAction`	string	Null	False	最初の失敗時のアクションを定義します。たとえば、再起動/なし。
`SecondFailureAction`	string	Null	False	2 回連続で障害が発生した場合のアクションを定義します。
`SubsequentFailureAction`	string	Null	False	2 回目以降のすべての障害に対するアクションを定義します。

サーバー再起動

マシンを再起動

このスクリプトは、オプションの delay オプションと force オプションを使用してローカルマシンを再起動します。

パラメーター

name	type	デフォルト	必須	注
`Force`	ブーリアン型	true	False	指定した場合、保存されていないデータやアクティブなユーザーセッションを無視して、即時再起動を強制します。
`Delay`	int	10	False	コンピューターが再起動されるまでの遅延時間を秒単位で指定します。3 秒から 30 秒の間でなければなりません。デフォルトは 10 秒です。

CDF トレーシング管理

CDF トレースの開始

このスクリプトは、CTL ファイルまたは定義済みの CTL ファイルのカテゴリを入力として受け取り、CDF ツールプロセスを開始し、CTL ファイル内のモデルのトレースを開始します。

パラメーター

name	type	デフォルト	必須	注
`traceOutputPath`	string	`C:\ProgramData\Citrix\WEM\CDFLogs`	False	CDF レポートの出力パスを指定します。
`category`	string	10	False	トレースを開始する定義済みのカテゴリを指定します。サポートされている値は `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`	string	Null	False	トレースを開始する`ctl`ファイルを指定します。

CDF トレースを停止する

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

CDF ログクリーンアップ

CDF トレースログをクリーンアップしてストレージ消費量を節約すると便利です。指定されたディレクトリにあるCDFファイルを削除する機能を提供する必要があります。

name	type	デフォルト	必須	注
`FileAgeDays`	int	3	False	年齢の閾値を日単位で指定します。この値より古いファイルとフォルダは削除されます。デフォルト値は 3 日で、このパラメータはオプションです。`FileAgeDays`が1日未満の場合、すべてのファイルまたはダイレクタが削除されます。

ヒント：

カスタムタスクと組み込みスクリプトタスクを区別できます。カスタムタスクには「CUSTOM」ラベル、組み込みタスクには「CITRIX」ラベルが付いています。

組み込みのスクリプトタスクは、常にカスタムタスクの上に表示されます。カスタムスクリプトタスクは、最終更新日時に基づいて降順でソートされます。

この機能を使用すると、独自の管理ニーズに合わせて WEM の機能を拡張できます。たとえば、組み込みのスクリプトタスクCloud Health Checkを使用すると、VDAの正常性を測定できます。タスクはスクリプトベースです。独自のスクリプトファイルを記述できます。次に、WEM を使用してタスクを自動化できるように、スクリプトファイルをスクリプト化されたタスクとして WEM に追加します。

スクリプト化されたタスクが実行されるたびに、対応するレポートが生成されます。このレポートには、タスクの実行日時、タスクの実行結果などに関する情報が含まれるため、タスクに関連するアクティビティを監査できます。

スクリプト化されたタスクは、構成セットレベルで機能します。スクリプト化されたタスクを使用する一般的なワークフローは次のとおりです。

[ スクリプト化されたタスク ] ページで、スクリプト化されたタスクを追加します。
スクリプト化されたタスクを有効にする設定セットに移動します。
その構成セットの [ スクリプト化されたタスクの設定] ページで、スクリプト化されたタスクを有効にします。「スクリプト化されたタスク設定」を参照してください。
必要に応じて、スクリプト化されたタスクに関連するレポートを表示します。そのためには次の 2 つの方法があります。
- [ 監視] > [レポート ] に移動し、そこでレポートを表示します。
- 設定セットの [ スクリプト化されたタスク ] または [ スクリプト化されたタスクの設定] ページに移動します。スクリプト化されたタスクを探し、省略記号を選択し、[ View reports] を選択します。[ モニタリング] > [レポート ] ページが表示され、関連するフィルタが自動的に適用されます。その後、関連レポートを表示できます。

スクリプト化されたタスクレポートについては、「レポート」を参照してください。