脚本化任务

Last published : Nov 13, 2026
Related information
管理 (Web 控制台)

简介

提示：
脚本化任务在计算机级别运行。要在用户会话级别运行任务，请改用外部任务。
此页面允许您添加脚本化任务，您可以自定义这些任务以适应您独特的工作区环境管理需求。然后，您可以通过在适用的配置集中配置这些任务，使用 Workspace Environment Management™ (WEM) 自动执行这些任务。
目前，我们提供以下内置脚本化任务供您使用：

云运行状况检查

允许您运行检查以评估虚拟投递代理 (VDA) 的运行状况。VDA 运行状况检查可识别常见 VDA 注册和会话启动问题的可能原因。云运行状况检查在代理主机上的本地系统帐户下运行。

Windows 服务管理

Windows 服务管理提供有关 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 字符串 空 否 设置服务的启动类型。有效选项为“自动”、“手动”或“禁用”。
FirstFailureAction 字符串 空 否 定义首次失败时的操作。例如，重新启动/无。
SecondFailureAction 字符串 空 否 定义第二次连续失败时的操作。
SubsequentFailureAction 字符串 空 否 定义第二次失败后所有后续失败的操作。

服务器重启

重启计算机

此脚本使用可选的延迟和强制选项重启本地计算机。
参数
名称 类型 默认值 强制 注意
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. （可选）查看与脚本化任务相关的报告。有两种方法可以执行此操作：
    • 转到监视 > 报告并在那里查看报告。
    • 转到脚本化任务或配置集的脚本化任务设置页面。找到脚本化任务，选择省略号，然后选择查看报告。然后，您将转到监视 > 报告页面，并自动应用相关筛选器。然后，您可以查看相关报告。
有关脚本化任务报告的信息，请参阅报告。

添加脚本化任务

要添加脚本化任务，请执行以下步骤：
  1. 在脚本化任务页面上，单击添加脚本化任务。
  2. 在添加脚本化任务向导中，配置以下设置，然后单击保存。
    • 任务名称。为任务指定一个名称。
    • 标记。从现有标记中选择，或输入以逗号分隔的标记。标记的长度不能超过 20 个字符。标记类似于关键字或标签。使用标记可以帮助您以新方式识别任务。此外，它们还可以充当筛选器，让您根据对您重要的条件重新排列“脚本化任务”中的任务视图。您可以根据需要使用任意数量的标记。
    • 描述。（可选）指定其他信息以帮助您识别任务。
    • 文件类型。为任务选择文件类型。支持两种类型的文件：
      • PowerShell。单个 PowerShell 脚本文件。
      • ZIP。捆绑到单个 zip 文件中的多个文件。不支持大于 10 MB 的 Zip 文件。上传 zip 文件后，指定一个入口点，指示在脚本化任务开始时运行哪个文件。请记住，入口点文件在文件夹结构中的深度不能超过三层。
    • 上传文件。单击“浏览”，导航到文件，选择该文件，然后单击“打开”。您将返回到“添加脚本化任务”向导。
    • 授予权限。指定要授予脚本化任务的访问级别。确保您了解与每个选项关联的权限。
      • 完全访问。分配了“完全访问”权限的脚本化任务具有广泛的本地访问权限。如果选择此选项，则脚本化任务将获得权限，如同它在本地系统帐户下运行一样。
      • 有限访问（具有网络访问权限）。分配了“有限访问（具有网络访问权限）”权限的脚本化任务不具有广泛的本地访问权限，但可以访问网络资源。如果选择此选项，则脚本化任务将获得权限，如同它在网络服务帐户下运行一样。
      • 有限访问（不具有网络访问权限）。分配了“有限访问（不具有网络访问权限）”权限的脚本化任务不具有广泛的本地访问权限，并且无法访问网络资源。如果选择此选项，则脚本化任务将获得权限，如同它在本地服务帐户下运行一样。
      有关详细信息，请参阅 Microsoft 文档 <https://docs.microsoft.com/zh-cn/windows/security/identity-protection/access-control/security-identifiers#well-known-sids>。
  • 工作文件夹。（可选）键入最终用户操作系统上本地文件夹的绝对路径。工作文件夹是文件启动时的当前文件夹。您可以使用环境变量构建路径（例如，%ProgramFiles%）。如果未指定，则 PSScriptRoot 用作默认工作文件夹。有关 PSScriptRoot 的详细信息，请参阅 Microsoft 文档 <https://docs.microsoft.com/zh-cn/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 以在 脚本化任务设置 页面中访问筛选后的任务，其中仅筛选出所选任务。

更多信息

有关如何使用脚本化任务的示例，请参阅：