スクリプト化されたタスク
はじめに
ヒント：
スクリプト化されたタスクは、マシン レベルで動作します。 ユーザーセッションレベルでタスクを実行するには、 外部タスク その代わりに。
このページでは、独自の環境管理ニーズに合わせてカスタマイズするスクリプト化されたタスクを追加できます。 その後、Workspace Environment Management (WEM) を使用して、該当する構成セットでこれらのタスクを構成することで、これらのタスクを自動化できます。
現在、次の組み込みのスクリプト タスクを提供しています。
クラウドヘルスチェック
Virtual Delivery Agent(VDA)の正常性を測定するチェックを実行できます。 VDAヘルスチェックでは、VDA登録とセッション起動の一般的な問題の考えられる原因を特定します。 Cloud Health Check は、エージェントホストのローカルシステムアカウントで実行されます。
Windows サービス管理
Windows サービス管理は、Windows サービスに関して頻繁に使用される機能 (開始、停止、再起動、1 つ以上の Windows サービスの構成など) を提供します。
Windowsサービスを再起動します
このスクリプトは、Windows サービスのステータスを確認します。 サービスが現在実行されておらず、 フォーススタート パラメーターが指定されている場合、スクリプトはサービスを開始します。 現在の状態に関係なく、サービスが実行中で強制的な開始を必要としない場合は、最新の構成で動作していることを確認するため、または停止状態から回復するために、サービスが再起動されます。
パラメーター
| 名前 | 種類 | デフォルト | 必須 | 注： |
|---|---|---|---|---|
ServiceNames |
string | ブローカーエージェント | 偽 | 管理するサービスの名前を指定します。 指定しない場合、デフォルトは ブローカーエージェント. 複数のサービスを入力する必要がある場合は、サービス名をカンマで区切ります。 すべてのスペースがトリミングされます。 たとえば、ServiceA、ServiceB などです。 |
ForceStart |
boolean | 真 | 偽 | サービスが実行されていないことが判明した場合にサービスを開始するかどうかを示します。 実行中のサービスには影響しません。実行中のサービスは、メンテナンスまたはリカバリの目的で常に再起動されます。 |
Windowsサービスを停止する
このスクリプトは、指定した Windows サービスの一覧を停止します。 このスクリプトは、各サービスがインストールされているかどうかを確認し、サービスの強制停止を試みます。 その後、スクリプトはサービスが正常に停止したかどうかを確認し、ステータスを報告します。
パラメーター
| 名前 | 種類 | デフォルト | 必須 | 注： |
|---|---|---|---|---|
ServiceNames |
string | ブローカーエージェント | 偽 | 管理するサービスの名前を指定します。 指定しない場合、デフォルトは ブローカーエージェント. 複数のサービスを入力する必要がある場合は、サービス名をカンマで区切ります。 すべてのスペースがトリミングされます。 たとえば、ServiceA、ServiceB などです。 |
Windows サービスの構成
このスクリプトは、スタートアップの種類や回復アクションなど、Windows サービスの構成を調整します。
パラメーター
| 名前 | 種類 | デフォルト | 必須 | 注： |
|---|---|---|---|---|
ServiceNames |
string | ヌル | 真 | 管理するサービスの名前を指定します。 指定しない場合、デフォルトは ブローカーエージェント. 複数のサービスを入力する必要がある場合は、サービス名をカンマで区切ります。 すべてのスペースがトリミングされます。 たとえば、ServiceA、ServiceivceB などです。 |
StartupType |
string | ヌル | 偽 | サービスのスタートアップの種類を設定します。 有効なオプションは、[自動]、[手動]、または [無効] です。 |
FirstFailureAction |
string | ヌル | 偽 | 最初の失敗に対するアクションを定義します。 たとえば、restart/none です。 |
SecondFailureAction |
string | ヌル | 偽 | 2 回連続する失敗のアクションを定義します。 |
SubsequentFailureAction |
string | ヌル | 偽 | 2 回目以降のすべての失敗に対するアクションを定義します。 |
サーバーの再起動
マシンの再起動
このスクリプトは、オプションの遅延と強制オプションを使用してローカル マシンを再起動します。
パラメーター
| 名前 | 種類 | デフォルト | 必須 | 注： |
|---|---|---|---|---|
Force |
boolean | 真 | 偽 | 指定した場合は、未保存のデータやアクティブなユーザー・セッションを無視して、即時に再起動します。 |
Delay |
int | 10 | 偽 | コンピュータが再起動されるまでの遅延を秒単位で指定します。 3 秒から 30 秒の間で指定する必要があります。 デフォルトは 10 秒です。 |
CDFトレーシング管理
CDF トレースの開始
このスクリプトは、CTL ファイルまたは定義済みのカテゴリの CTL ファイルを入力として受け取り、CDF ツール プロセスを開始し、CTL ファイル内のモデルのトレースを開始します。
パラメーター
| 名前 | 種類 | デフォルト | 必須 | 注： |
|---|---|---|---|---|
traceOutputPath |
string | C:\ProgramData\Citrix\WEM\CDFLogs |
偽 | CDF レポートの出力パスを指定します。 |
category
|
string
|
10
|
偽
|
トレースを開始する定義済みのカテゴリを指定します。 サポートされている値は次のとおりです
すべての常にトレースをオンデスクトップサーバーosvdaデリバリーコントローラーフェデレーション認証サービスプロビジョニング サービスユニバーサルプリントサーバーCitrixディレクターCitrixスタジオセッション録画の管理セッション録画プレーヤーWindows用のCitrix Workspaceアプリ |
ctlFilePath |
string | ヌル | 偽 | を指定します。 ctl トレースを開始するファイル。 |
CDF トレースの停止
このスクリプトは、CDF ツールのトレースを停止します。
CDF ログのクリーンアップ
CDF トレース ログをクリーンアップすると、ストレージの消費を節約できます。 指定されたディレクトリの下にあるCDFファイルを削除する機能を提供する必要があります。
| 名前 | 種類 | デフォルト | 必須 | 注： |
|---|---|---|---|---|
FileAgeDays |
int | 3 | 偽 | 経過時間のしきい値を日数で指定します。 この値より古いファイルとフォルダは削除されます。 デフォルト値は 3 日で、このパラメータはオプションです。 すべてのファイルまたはディレクターは、次の場合に削除されます。 FileAgeDays (英語) 1日未満です。 |
ヒント：
- カスタムタスクと組み込みスクリプトタスクを区別することができます:カスタムタスクには「CUSTOM」ラベルが付けられ、組み込みタスクには「CITRIX」ラベルが付けられます。
- 組み込みのスクリプト化されたタスクは、常にカスタムタスクの上に表示されます。 カスタムスクリプトタスクは、最終変更時刻に基づいて降順でソートされます。
この機能を使用すると、独自の管理ニーズに合わせて WEM の機能を拡張できます。 たとえば、組み込みのスクリプトタスクであるCloud Health Checkを使用すると、VDAの健康状態を測定できます。 タスクはスクリプトベースです。 独自のスクリプトファイルを書くことができます。 次に、スクリプト ファイルをスクリプト化されたタスクとして WEM に追加して、WEM を使用してタスクを自動化できるようにします。
スクリプト化されたタスクが実行されるたびに、対応するレポートが生成されます。 このレポートには、タスクの実行日時、タスクの実行結果などに関する情報が含まれているため、タスクに関連するアクティビティを監査できます。
スクリプト化されたタスクは、構成セット・レベルで動作します。 スクリプト化されたタスクを使用する一般的なワークフローは次のとおりです。
-
で スクリプト化されたタスク ページで、スクリプト化されたタスクを追加します。
-
スクリプト化されたタスクを有効にする設定セットに移動します。
-
で スクリプト化されたタスクの設定 ページで、スクリプト化されたタスクを有効にします。 見る スクリプト化されたタスクの設定.
-
必要に応じて、スクリプト化されたタスクに関連するレポートを表示します。 これを行うには、次の 2 つの方法があります。
- 行きます モニタリング > レポート そこでレポートを表示します。
- 行きます スクリプト化されたタスク または スクリプト化されたタスクの設定 ページに移動します。 スクリプト化されたタスクを見つけ、省略記号を選択してから、 レポートの表示. その後、に移動します。 モニタリング > レポート ページが表示され、関連するフィルターが自動的に適用されます。 その後、関連するレポートを表示できます。
スクリプト化されたタスクレポートの詳細については、以下を参照してください。 レポート.
スクリプト化されたタスクを追加する
スクリプト化されたタスクを追加するには、次の手順を実行します。
-
で スクリプト化されたタスク ページで、 スクリプト化されたタスクを追加.
-
の スクリプト化されたタスクを追加 ウィザードで、次の設定を構成し、 セーブ.
-
タスク名. タスクの名前を指定します。
-
タグ。 既存のタグから選択するか、タグをカンマで区切って入力します。 タグの長さは 20 文字以下にする必要があります。 タグは、キーワードやラベルのようなものです。 タグを使用すると、新しい方法でタスクを特定できます。 また、フィルターとしても機能し、重要な条件に応じてスクリプト化されたタスクのタスクの表示を並べ替えることができます。 タグはいくつでも使用できます。
-
[説明]。 必要に応じて、タスクの識別に役立つ追加情報を指定します。
-
ファイルの種類. タスクのファイルタイプを選択します。 次の 2 種類のファイルがサポートされています。
- PowerShellの. 個々の PowerShell スクリプト ファイル。
- 郵便番号. 複数のファイルを 1 つの zip ファイルにバンドル。 10 MB を超える zip ファイルはサポートされていません。 zip ファイルをアップロードした後、スクリプト化されたタスクの開始時に実行するファイルを示すエントリポイントを指定します。 エントリポイントファイルは、フォルダ構造内で3レベル以下の深さでなければならないことに注意してください。
-
ファイルをアップロードします。 クリック ブラウズをクリックし、ファイルに移動して選択し、 開ける. に戻ります スクリプト化されたタスクを追加 魔法使い。
-
アクセス許可の付与. スクリプト化されたタスクに付与するアクセスのレベルを指定します。 各オプションに関連付けられている権限を理解していることを確認してください。
- フルアクセス. フルアクセスが割り当てられたスクリプト化されたタスクには、広範なローカルアクセス権があります。 選択すると、スクリプト化されたタスクには、ローカルシステムアカウントで実行されているかのように権限が付与されます。
- 制限付きアクセス (ネットワーク アクセスあり). 制限付きアクセス (ネットワーク アクセスあり) が割り当てられたスクリプト化されたタスクは、広範なローカル アクセスを持ちませんが、ネットワーク リソースにアクセスできます。 選択すると、スクリプト化されたタスクには、ネットワーク サービス アカウントで実行されるかのようにアクセス許可が付与されます。
- 制限付きアクセス (ネットワーク アクセスなし). 制限付きアクセス (ネットワーク アクセスなし) が割り当てられたスクリプト化されたタスクは、広範なローカル アクセスを持たず、ネットワーク リソースにアクセスできません。 選択すると、スクリプト化されたタスクには、ローカルサービスアカウントで実行されるかのように権限が付与されます。
詳細については、Microsoft のドキュメントを参照してください https://docs.microsoft.com/en-us/windows/security/identity-protection/access-control/security-identifiers#well-known-sids.
-
-
作業フォルダ。 必要に応じて、エンドユーザーオペレーティングシステム上のローカルフォルダの絶対パスを入力します。 作業フォルダは、ファイルの開始時の現在のフォルダです。 環境変数 (たとえば、 %ProgramFiles%). 指定しない場合、
PSScriptルートは、デフォルトの作業フォルダとして使用されます。 詳細については、PSScriptルートについては、Microsoft のマニュアルを参照してください https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_automatic_variables?view=powershell-7.1. -
このタスクは出力ファイルを生成しますか. 追加するタスクが出力ファイルを生成するかどうかを選択します。
-
出力パス. ファイルが存在するフォルダからの相対パスを入力します。 パスには、ファイル名とファイル名拡張子が含まれている必要があります。 例：
アウトプット\report.txt.
スクリプト化されたタスクの編集
スクリプト化されたタスクを編集するには、次の手順を実行します。
-
で スクリプト化されたタスク ページで、タスクを見つけます。 必要に応じて、検索ボックスを使用してタスクをすばやく検索します。
-
タスクの省略記号をクリックし、 タスクの編集. ザ スクリプト化されたタスクの編集 ウィザードが表示されます。
-
で タスク情報 タブで、必要に応じて設定を構成します。
-
で スクリプトの内容 タブで、スクリプトの内容を表示します。
-
［保存］ をクリックします。
注意:
組み込みのスクリプト化されたタスクは編集できません。
スクリプト化されたタスクを削除する
スクリプト化されたタスクを削除するには、次の手順を実行します。
-
で スクリプト化されたタスク ページで、タスクを見つけます。 必要に応じて、検索ボックスを使用してタスクをすばやく検索します。
-
タスクの省略記号をクリックし、 タスクの削除.
重要:
- 組み込みのスクリプト化されたタスクは削除できません。
- 一部の構成セットで現在有効になっているスクリプト化されたタスクを削除するには、まずそれらの構成セットでそのタスクを無効にします。
スクリプト化されたタスクのクローン作成
スクリプト化されたタスクをクローンするには、次の手順を実行します。
-
で スクリプト化されたタスク ページで、タスクを見つけます。 必要に応じて、検索ボックスまたはタグを使用してタスクをすばやく見つけます。
-
タスクの省略記号をクリックし、 クローンタスク.
注意:
タスクをクローニングすると、名前の重複を避けるために名前を変更するように求められます。
タスク設定オプションの構成
タスク設定にすばやくアクセスするには、次の手順を実行します。
-
で スクリプト化されたタスク ページで、タスクを見つけます。 必要に応じて、検索ボックスまたはタグを使用してタスクをすばやく見つけます。
-
タスクの省略記号をクリックし、 タスク設定を構成する.
-
で設定セットを選択します。 構成セットの選択 魔法使い。
-
クリック 行く フィルタリングされたタスクにアクセスするには、 スクリプト化されたタスクの設定 ページで、選択したタスクのみが除外されます。
追加情報
スクリプト化されたタスクの使用方法の例については、以下を参照してください。