Workspace Environment Management

查看 PDF

脚本化任务

September 12, 2024

投稿者:

简介

提示：

脚本化任务在计算机级别上运行。要在用户会话级别运行任务，请改用外部任务。

此页面允许您添加脚本化任务，您可以根据自己的独特环境管理需求对这些任务进行自定义。然后，您可以使用 Workspace Environment Management (WEM) 自动执行这些任务，方法是在适用的配置集中进行配置。

目前，我们提供了以下内置脚本任务供您使用：

Cloud Health Check
Windows 服务管理
服务器重新启动
CDF 跟踪管理

Cloud Health Check

允许您运行检查以衡量虚拟交付代理 (VDA) 的运行状况。VDA 运行状况检查确定常见 VDA 注册和会话启动问题的可能的原因。Cloud 运行状况检查在代理主机上的本地系统帐户下运行。

Windows 服务管理

Windows 服务管理提供有关 Windows 服务的常用功能，例如启动、停止、重新启动、配置一个或多个 Windows 服务。

重新启动 Windows 服务

此脚本检查 Windows 服务的状态。如果服务当前未运行且指定了 ForceStart 参数，则脚本将启动该服务。无论当前状态如何，如果服务正在运行且不需要强制启动，则会重新启动该服务，以确保其在最新配置下运行或从停滞状态中恢复。

参数

name	type	default	mandatory	注意
`ServiceNames`	字符串	BrokerAgent	False	指定要托管的服务的名称。如果未提供，则默认为 `BrokerAgent`。如果您需要输入多个服务，请用逗号分隔服务名称。所有空格都将被修剪。例如，ServiceA、ServiceB。
`ForceStart`	布尔值	true	False	表示如果发现服务未运行，是否启动该服务。它不会影响正在运行的服务；出于维护或恢复的目的，正在运行的服务始终会重新启动。

停止 Windows 服务

此脚本停止指定的 Windows 服务列表。该脚本检查是否安装了每项服务并尝试强制停止该服务。然后，该脚本会验证服务是否已成功停止并报告状态。

参数

name	type	default	mandatory	注意
`ServiceNames`	字符串	BrokerAgent	False	指定要托管的服务的名称。如果未提供，则默认为 `BrokerAgent`。如果您需要输入多个服务，请用逗号分隔服务名称。所有空格都将被修剪。例如，ServiceA、ServiceB。

配置 Windows 服务

此脚本调整 Windows 服务配置，包括启动类型和恢复操作。

参数

name	type	default	mandatory	注意
`ServiceNames`	字符串	空值	true	指定要托管的服务的名称。如果未提供，则默认为 `BrokerAgent`。如果您需要输入多个服务，请用逗号分隔服务名称。所有空格都将被修剪。例如，ServiceA、SerivceB。
`StartupType`	字符串	空值	False	设置服务的启动类型。有效选项为“自动”、“手动”或“已禁用”。
`FirstFailureAction`	字符串	空值	False	定义第一次失败时的操作。例如，重新启动/无。
`SecondFailureAction`	字符串	空值	False	定义连续第二次失败的操作。
`SubsequentFailureAction`	字符串	空值	False	定义第二次失败之后所有后续失败的操作。

服务器重新启动

重新启动计算机

此脚本使用可选的延迟和强制选项重新启动本地计算机。

参数

name	type	default	mandatory	注意
`Force`	布尔值	true	False	如果指定，则强制立即重新启动，忽略任何未保存的数据或活跃的用户会话。
`Delay`	int	10	False	指定计算机重新启动前的延迟（以秒为单位）。必须介于 3 到 30 秒之间。默认值为 10 秒。

CDF 跟踪管理

启动 CDF 跟踪

此脚本将 CTL 文件或预定义类别的 CTL 文件作为输入，启动 CDF 工具进程并开始跟踪 CTL 文件中的模型。

参数

name	type	default	mandatory	注意
`traceOutputPath`	字符串	`C:\ProgramData\Citrix\WEM\CDFLogs`	False	指定 CDF 报告的输出路径。
`category`	字符串	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`	字符串	空值	False	指定用于开始跟踪的 `ctl` 文件。

停止 CDF 跟踪

此脚本停止 CDF 工具跟踪。

CDF 日志清理

清理 CDF 跟踪日志以节省存储消耗非常有用。它应该提供删除给定目录下的 CDF 文件的功能。

name	type	default	mandatory	注意
`FileAgeDays`	int	3	False	以天为单位指定年龄阈值。早于此值的文件和文件夹将被删除。默认值为 3 天，此参数是可选的。如果 `FileAgeDays` 少于 1 天，则所有文件或目录都将被删除。

提示：

您可以区分自定义任务和内置脚本任务：自定义任务标有“CUSTOM”标签，内置任务标有“CITRIX”标签。

内置脚本任务总是显示在自定义任务之上。自定义脚本任务根据上次修改时间按降序排序。

借助此功能，您可以扩展 WEM 的功能，以满足您独特的管理需求。例如，通过内置脚本任务 Cloud Health Check，您可以衡量 VDA 的运行状况。该任务是基于脚本的。您可以编写自己的脚本文件。然后，将脚本文件作为脚本任务添加到 WEM 中，以便使用 WEM 自动执行任务。

每次运行脚本任务时，都会为其生成相应的报告。该报告包含有关任务何时运行、任务执行结果等信息，从而使您能够审核与任务相关的活动。

脚本化任务在配置集级别工作。使用脚本化任务的一般工作流程如下所示：

在“脚本化任务”页面上，添加脚本化任务。
导航到要为其启用脚本化任务的配置集。
在该配置集的“脚本化任务设置”页面上，启用脚本化任务。请参阅脚本化任务设置。
或者，查看与脚本化任务相关的报告。有两种方法可以做到这一点：
- 转到 监视 > 报告 并在那里查看报告。
- 转到 脚本任务 或配置集的“脚本化任务设置”页面。找到脚本任务，选择省略号，然后选择查看报表。然后，您将转到“监视”>“报告”页面，并自动应用相关筛选器。然后，您可以查看相关报告。

有关脚本化任务报告的信息，请参阅报告。

添加脚本化任务

要添加脚本任务，请执行以下步骤：

在“脚本化任务”页面上，单击“添加脚本化任务”。
在 添加脚本任务 向导中，配置以下设置，然后单击保存。
- 任务名称。指定任务的名称。
- 标记。从现有标签中选择或输入以逗号分隔的标签。标签的长度不得超过 20 个字符。标记类似于关键字或标签。使用标签使您能够以新的方式识别任务。此外，它们还充当筛选器，允许您根据重要的条件重新排列脚本化任务中的任务视图。您可以随心所欲地使用任意数量的标签。
- 说明。（可选）指定其他信息以帮助您确定任务。
- 文件类型。选择任务的文件类型。支持两种类型的文件：
  - PowerShell。单个 PowerShell 脚本文件。
  - ZIP。多个文件捆绑到一个 zip 文件中。不支持大于 10 MB 的 Zip 文件。上载 zip 文件后，指定一个入口点，指示在脚本任务开始时要运行的文件。请记住，入口点文件在文件夹结构中的深度不得超过三层。
- 上载文件。单击“浏览”，导航到该文件，将其选中，然后单击“打开”。您将返回到 添加脚本任务 向导。
- 授予权限。指定要授予脚本任务的访问权限级别。确保您了解与每个选项关联的权限。
  - 完全访问权限。分配了完全访问权限的脚本任务具有广泛的本地访问权限。如果选中此选项，则将授予脚本任务的权限，就好像它使用本地系统帐户运行一样。
  - 访问受限（具有网络访问权限）。分配了受限访问权限（具有网络访问权限）的脚本任务没有广泛的本地访问权限，但可以访问网络资源。如果选中此选项，则将授予脚本任务的权限，就好像它使用网络服务帐户运行一样。
  - 访问受限（没有网络访问权限）。分配了受限访问权限（无网络访问权限）的脚本任务没有广泛的本地访问权限，也无法访问网络资源。如果选中此选项，则将授予脚本任务的权限，就好像它使用本地服务帐户运行一样。
  For more information, see the Microsoft documentation https://docs.microsoft.com/en-us/windows/security/identity-protection/access-control/security-identifiers#well-known-sids.

工作文件夹。或者，键入最终用户操作系统上本地文件夹的绝对路径。工作文件夹是文件启动时的当前文件夹。您可以使用环境变量（例如 %ProgramFiles%）构建路径。如果未指定，PSScriptRoot 将用作默认工作文件夹。有关 PSScriptRoot 的详细信息，请参阅 Microsoft 文档 https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_automatic_variables?view=powershell-7.1。
此任务是否生成输出文件。选择您添加的任务是否生成输出文件。
输出路径。键入相对于文件所在文件夹的路径。路径必须包含文件名和文件扩展名。示例：output\report.txt。

编辑脚本化任务

要编辑脚本任务，请执行以下步骤：

在脚本化任务页面上，找到该任务。如果需要，可使用搜索框快速搜索任务。
单击任务的省略号，然后选择编辑任务。此时将显示“编辑脚本化任务”向导。
在 任务信息 选项卡上，根据需要配置设置。
在 脚本内容 选项卡上，查看脚本内容。
单击保存。

注意：

您无法编辑内置脚本化任务。

删除脚本化任务

要删除脚本任务，请执行以下步骤：

在脚本化任务页面上，找到该任务。如果需要，可使用搜索框快速搜索任务。
单击任务的省略号，然后选择删除任务。

重要：

您无法删除内置脚本任务。

要删除当前为某些配置集启用的脚本化任务，请先在这些配置集中禁用它。

克隆脚本化任务

要克隆脚本任务，请执行以下步骤：

在脚本化任务页面上，找到该任务。如果需要，请使用搜索框或标签快速查找任务。
单击任务的省略号，然后选择 克隆任务。

注意：

克隆任务时，系统会提示您更改名称以避免名称重复。

配置任务设置选项

要快速进入任务设置，请执行以下步骤：

在脚本化任务页面上，找到该任务。如果需要，请使用搜索框或标签快速查找任务。
单击任务的省略号，然后选择 配置任务设置。
在选择配置集向导 中选择配置集 。
单击“开始”可访问“脚本化任务设置”页面中的筛选任务 ，在该页面中，只有选定的任务会被过滤掉。