Workspace Environment Management

查看 PDF

脚本任务

December 11, 2024

投稿者:

简介

提示：

脚本化任务在计算机级别工作。要在用户会话级别运行任务，请使用外部任务相反。

此页面允许您添加脚本化任务，您可以自定义这些任务以满足您独特的环境管理需求。然后，您可以通过在适用的配置集中配置这些任务，使用 Workspace Environment Management （WEM）自动执行这些任务。

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

云健康检查
Windows 服务管理
服务器 Reoobt
CDF 跟踪管理

云健康检查

允许您运行检查来衡量 Virtual Delivery Agent （VDA）的运行状况。 VDA 运行状况检查可确定常见 VDA 注册和会话启动问题的可能原因。 Cloud Health Check 在代理主机上的本地系统账户下运行。

Windows 服务管理

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

重新启动 Windows 服务

此脚本检查 Windows 服务的状态。如果服务当前未运行，并且 强制启动 parameter 时，脚本将启动服务。无论当前状态如何，如果服务正在运行且不需要强制启动，则会重新启动该服务，以确保它在最新配置上运行或从停止状态中恢复。

参数

名字	类型	默认值	命令的	注意
`ServiceNames`	字符串	经纪人代理	假	指定要管理的服务的名称。如果未提供，则默认为 `经纪人代理`. 如果需要输入多个服务，请用逗号分隔服务名称。所有空格都将被修剪。例如，ServiceA、ServiceB。
`ForceStart`	布尔值	true	假	指示在发现服务未运行时是否启动服务。它不会影响正在运行的服务;出于维护或恢复目的，正在运行的服务始终会重新启动。

停止 Windows 服务

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

参数

名字	类型	默认值	命令的	注意
`ServiceNames`	字符串	经纪人代理	假	指定要管理的服务的名称。如果未提供，则默认为 `经纪人代理`. 如果需要输入多个服务，请用逗号分隔服务名称。所有空格都将被修剪。例如，ServiceA、ServiceB。

配置 Windows 服务

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

参数

名字	类型	默认值	命令的	注意
`ServiceNames`	字符串	零	true	指定要管理的服务的名称。如果未提供，则默认为 `经纪人代理`. 如果需要输入多个服务，请用逗号分隔服务名称。所有空格都将被修剪。例如，ServiceA、SerivceB。
`StartupType`	字符串	零	假	设置服务的启动类型。有效选项包括 Automatic （自动）、Manual （手动）或 Disabled （禁用）。
`FirstFailureAction`	字符串	零	假	定义第一个失败的操作。例如，restart/none。
`SecondFailureAction`	字符串	零	假	定义第二次连续失败的操作。
`SubsequentFailureAction`	字符串	零	假	定义第二次失败后所有后续失败的操作。

服务器重启

重启机器

此脚本使用可选的 delay 和 force 选项重新启动本地计算机。

参数

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

CDF 跟踪管理

启动 CDF 跟踪

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

参数

名字	类型	默认值	命令的	注意
`traceOutputPath`	字符串	`C:\ProgramData\Citrix\WEM\CDFLogs`	假	指定 CDF 报告的输出路径。
`category`	字符串	10	假	指定要用于启动跟踪的预定义类别。支持的值包括 `都` `始终在线跟踪` `桌面服务器操作系统 vda` `交付控制器` `联合身份验证服务` `供应服务` `通用打印服务器` `Citrix Director` `Citrix Studio` `Session Recording 管理` `Session Recording 播放器` `适用于 Windows 的 Citrix Workspace 应用程序`












`ctlFilePath`	字符串	零	假	指定 `ctl` 文件以启动跟踪。

停止 CDF 跟踪

此脚本将停止 CDF 工具跟踪。

CDF 日志清理

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

名字	类型	默认值	命令的	注意
`FileAgeDays`	int	3	假	指定存在时间阈值（以天为单位）。早于此值的文件和文件夹将被删除。默认值为 3 天，此参数为可选参数。如果 `FileAgeDays 文件` 少于 1 天。

提示：

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

内置脚本任务始终显示在自定义任务的上方。自定义脚本任务根据上次修改时间按降序排序。

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

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

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

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

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

添加脚本任务

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

在 脚本化任务 页面上，单击 添加脚本化任务.
在 添加脚本化任务 向导中，配置以下设置，然后单击救.
- 任务名称. 指定任务的名称。
- 标记。从现有标记中进行选择，或输入以逗号分隔的标记。标记的长度不得超过 20 个字符。标签类似于关键字或标签。使用标签使您能够以新的方式识别您的任务。此外，它们还充当筛选器，允许您根据对您重要的条件重新排列脚本化任务中的任务视图。您可以使用任意数量的标签。
- 说明。（可选）指定其他信息以帮助您识别任务。
- 文件类型. 选择任务的文件类型。支持两种类型的文件：
  - PowerShell. 单个 PowerShell 脚本文件。
  - 邮编. 将多个文件捆绑到一个 zip 文件中。不支持大于 10 MB 的 zip 文件。上传 zip 文件后，指定一个入口点，指示要在脚本化任务开始时运行哪个文件。请记住，入口点文件在文件夹结构中的深度不得超过三层。
- 上传文件。 点击浏览，导航到该文件，选择它，然后单击打开. 您将返回到 添加脚本化任务 巫师。
- 授予权限. 指定要授予脚本化任务的访问级别。确保您了解与每个选项关联的权限。
  - 完全访问权限. 分配了 Full access 的脚本化任务具有广泛的本地访问权限。如果选中，则会向脚本化任务授予权限，就像它在本地系统账户下运行一样。
  - 受限访问（具有网络访问权限）. 分配了 Limited access （with network access）的脚本化任务没有广泛的本地访问权限，但可以访问网络资源。如果选中，则会向脚本化任务授予权限，就像它在网络服务账户下运行一样。
  - 受限访问（无网络访问）. 分配了受限访问权限（无网络访问权限）的脚本化任务没有广泛的本地访问权限，并且无法访问网络资源。如果选中，则会向脚本化任务授予权限，就像在本地服务账户下运行一样。
  有关更多信息，请参阅 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.

编辑脚本化任务

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

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

注意：

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

删除脚本化任务

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

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

重要：

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

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

克隆脚本化任务

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

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

注意：

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

配置任务设置选项

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

在 脚本化任务 页面上，找到该任务。如果需要，请使用搜索框或标签快速查找任务。
单击任务的省略号，然后选择 配置任务设置.
在 选择配置集 巫师。
点击去要访问 脚本化任务设置 页面上，其中仅筛选出所选任务。