Paragon Insights 规则和行动手册
对一家公司很重要的设备或网络性能元素对另一家公司可能并不重要。Paragon Insights(前身为 HealthBot)使用规则和操作手册来定义关键绩效指标 (KPI),并将它们组织成应用于网络设备的组。
本文档介绍了创建、编辑和删除 Paragon Insights 规则和操作指南所涉及的任务。
添加预定义规则
瞻博网络创建了一组预定义的规则,您可以使用这些规则从各种瞻博网络组件及其所在的网络中收集信息。您可以随时将这些规则添加到 Paragon Insights。安装后,许多默认的预定义规则将显示在“规则”和“操作指南”页面中。预定义的规则无法更改或删除;但是,只需单击规则定义右上角的 “克隆 ”按钮,即可克隆任何规则(预定义规则或用户定义规则)。克隆的规则转到 外部 主题,可以随意重新配置。
要将其他预定义规则上传到 Paragon Insights,请执行以下操作:
使用 Paragon Insights GUI 创建新规则
要使用 Paragon Insights GUI 创建新规则,您需要首先填写有关规则的一般描述性信息,然后在“规则”页面中浏览多个规则定义块,以提供 Paragon Insights 规则的特定配置。
要开始创建新的 Paragon Insights 规则,请执行以下操作:
单击左侧导航栏中的 配置>规则 图标。按 Paragon Insights 主题组织的 Paragon Insights 规则列表显示在“规则”页面的左侧。
单击添加规则按钮(+ 添加规则)。
使用以下输入参数输入有关规则的一般描述性信息:
参数
描述
规则
对于新规则,此参数预填充 external / user_rule_random characters,例如
external / user_rule_2p0ghk
。用斜杠 (/) 分隔的字段分别表示 Paragon Insights 主题名称和 Paragon Insights 规则名称。外部 是用于用户定义主题的主题名称。对于瞻博网络预定义的 Paragon Insights 规则,瞻博网络精心整理了一组基于设备组件的预定义主题名称。有关 Paragon Insights 主题的更多信息,请参阅 Paragon Insights 主题。
将 user_rule_random characters 规则名称替换为能够恰当地表示规则说明的名称,例如 数据包输入、 数据包输出、 system_memory等。
规则频率
(仅限网络规则)指定 Paragon Insights 收集网络规则数据的频率。如果规则包含在应用于网络组的频率配置文件中,则会覆盖此设置。
描述
(可选)输入规则的详细说明。
简介
(可选)输入规则的简要说明。当您将鼠标悬停在“规则”页面左侧列出的规则名称上时,将显示概要。
字段聚合时间范围
此可选值定义 Paragon Insights 聚合传感器接收的数据的频率。这有助于减少时序数据库中的数据点条目数。
(仅限网络规则)如果新规则是网络规则,请将网络规则开关切换到右侧。
根据需要配置规则定义块。
位于 Synopsis 输入参数的正下方,您将找到指向以下规则定义块的链接: 传感器、 字段、 向量、 变量、 函数、 触发器和 规则属性。以下各节介绍每个规则定义块的输入参数。
选择以下选项之一以保存新规则:
救
将规则保存在定义的主题区域中,但不部署更新的配置。例如,当您进行多项更改并希望同时部署所有更新时,可以使用此选项。
保存和部署
立即部署配置并将规则保存在定义的主题区域中。
以下部分介绍了每个 Paragon Insights 规则定义块的输入参数:
规则过滤
从 HealthBot 3.0.0 版开始,您可以筛选“规则”页面左侧显示的主题和规则。这使您可以快速找到所需的规则。搜索功能适用于主题、规则、传感器类型和其他类别;不仅要处理标题,还要处理规则的定义内容。
以下过程说明此筛选功能。
导航到左侧导航栏中的 “配置>规则 ”。
将显示 “规则 ”页。规则定义区域的左侧是一个新部分,如下 图 1 所示。
图 1:规则过滤从下拉菜单中,选择要执行的搜索类型。
在搜索字段中,开始输入搜索文本。
下面的主题列表缩小以仅显示与您的搜索条件匹配的主题和规则。
传感器
开始使用 传感器 块配置新规则。 图 2 显示了 OpenConfig 传感器 pppoe-error-statistics
的传感器定义。
单击添加传感器按钮(+添加传感器)。
此时将显示一个新的传感器定义,并将其命名为 Sensor_random characters,如
Sensor_2kgf04
。将传感器名称更改为对要定义的规则有意义的名称。
从下拉列表中,选择传感器类型。您可以选择以下选项之一: OpenConfig、 Native GPB、 iAgent、 SNMP、 Syslog 或 NetFlow。
定义 “传感器类型 ”所需的元素会根据所做的选择而变化。频率以 #s、#m、#h、#d、#w、#y 或 #o 表示,其中 # 是数字,s、m、h、d、w、y 分别指定秒、分钟、小时、天、周、年和偏移量。o 表达式用于定义用于公式、引用、触发器、学习周期和保持时间的偏移乘数。
以下列表描述了根据您选择的 传感器类型而更改的元素。其他规则元素不会因“ 传感器类型 ”选择而更改。
-
OpenConfig 传感器路径 是从可用 OpenConfig 传感器的下拉列表中定义的。 频率 是指传感器向 Paragon Insights 报告的频率(以秒为单位)。如果传感器包含在频率曲线中,则可以覆盖频率。
-
Native GPB 传感器路径 是指本机 GPB 传感器的路径。 端口 是指传感器与 Paragon Insights 通信的 GPB 端口。
-
iAgent 文件 是定义 NETCONF 可访问传感器的 YAML 格式文件的名称。 表 是从 YAML 文件中可用 PyEZ 表和视图的下拉列表中定义的。 频率 是指 Paragon Insights 轮询传感器的频率,可以通过将传感器包含在频率配置文件中来覆盖频率。
根据您选择的表,可能还会提供目标参数或动态参数的输入字段。对于这些附加字段,您可以执行以下操作之一:
将输入字段留空。不会应用默认值。
输入将保持不变的固定值。
输入用双花括号/花括号括起来的变量名称(例如, {{test-variable}}) 变量名称必须属于之前在 Paragon Insights 规则中定义的变量,并且该变量的 “类型 ”选项必须设置为 “传感器参数”。
-
SNMP 表 是从可用 SNMP 表的下拉列表中定义的。 频率 是指 Paragon Insights 轮询设备以获取数据的频率(以秒为单位),可以通过将传感器包含在频率配置文件中来覆盖。
-
Syslog 模式集 是用户配置的元素,其中包含一个或多个模式(您可以为要监视的每个事件配置模式)。 最长保持期 用于高级情况,是指在使用模式集中的多个模式关联事件时系统等待的最长时间。
注意:系统日志传感器需要一些预配置。有关更多详细信息,请参阅 系统日志摄取 。
-
Flow 模板名称 是瞻博网络提供的 NetFlow v9 和 IPFIX 模板的内置列表。
-
领域
传感器通常会携带有关多个事物的信息。例如,监视接口的传感器具有有关设备上所有接口的信息。在 Paragon Insights 中,我们称这些东西为 Fields。现在您已经定义了传感器,您需要告诉 Paragon Insights 您感兴趣的领域。
单击 字段 链接。
屏幕将更新并显示定义的字段对象。
单击添加字段按钮 (+添加字段)。
将随机字段名称替换为对要定义的规则有意义的名称,例如 接口名称、 配置阈值等。
(可选)为新字段添加描述性文本。
设置适当的 字段类型。字段类型的选项包括:字符串、整数、浮点数和无符号整数。字符串是默认字段类型。
从 Paragon Insights 4.2.0 版开始,您还可以选择无符号整数作为字段类型。无符号整数是一种数据类型,可以包含 0 到 4,294,967,295 之间的值。
(可选)切换添加到 规则键 开关。
键开关的添加规则告诉 Paragon Insights,此字段应被索引和搜索。例如,启用此开关时,字段名称将列在“设备”页上的 “密钥 ”列下。
从下拉菜单中选择适当的采集类型(字段源)。
以下列表显示了可用于 “引入类型(字段源) ”菜单的选项。
传感器 - 使用此或其他传感器定义。
路径 - 遵循传感器定义中的此开放配置或 Netconf 路径,以收集接口名称等特定数据。对于 iAgent 传感器, 路径 是指在 YAML 文件中定义的路径。
其中 – 过滤可用数据以收集有关其中特定元素(如特定接口)的信息。此字段可以引用规则中其他位置定义的 变量 。引用变量时,请使用用斜杠括起来的 moustache 表示法,例如: {{interface_name}}。
零抑制 - 对于与运行 Junos OS 的设备关联的某些传感器(如 Junos 遥测接口开放配置和本机 GPB 传感器),当数据值为零时,传感器不会发送任何现场数据。启用零抑制开关,以便在传感器不发送字段数据时将字段数据值设置为零。
缺少数据 - 每当传感器不发送任何数据时,指定一个值作为默认数据值。指定值的格式应与定义的字段类型(字符串、整数或浮点数)匹配。如果还启用了零抑制开关,则忽略指定的“如果缺失数据”值,并将默认传感器数据值设置为零。
引用 - 对来自其他规则的字段或触发器值的引用。
缺少数据 - 指定一个值作为默认数据值,只要没有提取引用数据。指定值的格式应与定义的字段类型(字符串、整数或浮点数)匹配。
常量 – 在引用规则中定义的变量时使用常量,该 变量 的值不会更改,例如 IO_Drops_Threshold 常量也可以是不会更改且不是对变量的引用的字符串或数值。
常量值 – 使用 moustache 表示法来引用变量,如下所示: {{IO_Drops_Threshold}}。
公式 – 从 公式 下拉菜单中选择所需的数学公式。
(可选)设置 字段聚合时间范围。此定期聚合设置位于具有常规规则参数的“字段”选项卡上方,有助于减少在数据库中输入的数据点数。例如,如果传感器设置指定 Paragon Insights 每 10 秒摄取一次数据,则可以将此设置配置为聚合并记录相关字段数据,例如,每 60 秒一次。请注意,使用此设置时,任何特定于字段的时间范围都必须使用相同的值。
从 HealthBot 3.1.0 版开始,您可以根据传入数据是否满足标记配置文件中定义的用户定义条件,向规则添加字段和键。标记配置文件在 Paragon Insights 左侧导航栏的 “设置>摄取设置 ”下定义。有关详细信息,请参阅 Paragon Insights 标记 。
向量
(可选)现在,您已经为规则定义了传感器和字段,可以定义向量了。
当单个字段具有多个值或从另一个字段接收值时,将使用向量。
单击 矢量 链接。图 3 显示了新添加的矢量的“向量”块。
图 3:矢量块单击添加矢量按钮(+添加矢量)
将随机向量名称替换为对您的规则有意义的名称。
从下拉列表中选择引入类型。其他输入字段将根据您所做的选择而有所不同。
对于路径:
参数
描述
字段列表
从下拉列表中选择一个字段。字段列表派生自此规则中的所有已定义字段。
时间范围
指定应从中收集数据的时间范围。时间范围以 #s、#m、#h、#d、#w 表示 #y,其中 # 是一个数字,s、m、h、d、w、y 分别指定秒、分钟、小时、天、周和年。例如,输入 7 天作为 7d。
对于公式:
参数
描述
公式类型
从下拉列表中选择公式类型:
unique 使用来自另一个向量的唯一元素创建向量。
and 比较两个向量,并返回一个向量,其中包含两个向量共有的元素。
or 比较两个向量,并返回一个包含两个向量的元素的向量。
unless 比较两个向量,并返回一个向量,其中包含来自左向量的元素,而不是右向量的元素。
矢量名称
(仅限唯一配方类型)从下拉列表中选择矢量名称。向量列表派生自此规则中所有定义的向量。
左向量
从下拉列表中选择矢量名称。向量列表派生自此规则中所有定义的向量。
右向量
从下拉列表中选择矢量名称。向量列表派生自此规则中所有定义的向量。
变量
(可选) 变量 块用于定义传感器中感兴趣的部分。例如,监视接口吞吐量的规则需要能够从设备上的可用接口列表中识别特定接口。下面将讨论字段详细信息。
单击 变量 选项卡。
单击添加变量按钮(+ 添加变量)
将随机 变量名称 替换为对您的规则有意义的变量名称,例如 pem-power-usage-threshold。
最佳实践:瞻博网络在 Paragon Insights 中元素命名的公认惯例是始终以小写字母开头,并使用连字符分隔单词。确保您的变量名称是唯一的、名称清晰的,并遵循可识别的模式,以便其他人可以理解变量的用途。任何缩写都应始终一致地使用。
在 默认值字段中 设置适当的默认值。
默认值因字段类型而异。整型字段类型使用数值默认值,而字符串字段类型使用字符串设置精确默认值,并使用正则表达式允许您从列表中设置默认值。规则定义期间设置的任何默认值都可以在应用时在设备或设备组级别覆盖。
从 “类型” 下拉列表中选择适当的变量类型。
可用的字段类型包括:整数、浮点、字符串、布尔值、设备、设备组和无符号整数。
从 Paragon Insights 4.2.0 版开始,您还可以选择无符号整数作为变量类型。无符号整数是一种数据类型,可以包含 0 到 4,294,967,295 之间的值。
功能
(可选)定义任何需要的功能。
函数块允许用户在 python 文件中创建函数并引用该文件中可用的方法。python 文件必须在 Paragon Insights 之外创建。您必须了解方法名称和任何参数,因为在定义函数时将需要它们。
从 Paragon Insights 4.2.0 版本开始,您可以使用 Python 用户定义函数返回多个值。
例如,假设您有一个具有三个返回值的函数example_function.py。在规则中调用example_function.py时,用户定义函数 (UDF) 中的第一个返回值存储在调用该函数的规则字段中。您只需为其余两个返回值配置返回字段,例如 r2 和 r3。您可以在“函数”选项卡的“返回列表”中为返回值配置这些字段。
在时间序列数据库中,返回列表字段的名称以使用 UDF 的规则字段的名称为前缀。例如, rule_field_name-r2。
图 4 显示了该chassis.power/check=pem-power-usage
规则的函数块。下面将讨论字段详细信息。
要配置函数:
单击 “功能 ”链接。
单击 + 添加函数。
输入函数名称,例如 used-percentage。
在 函数路径 字段中,输入包含函数的 python 文件的名称。这些文件必须存储在 /var/local/healthbot/input/hb-default 目录中。下拉列表中填充了该目录中的所有 Python (.py) 文件。
在 Method Name 字段中,输入 python 文件中定义的方法的名称。例如, used_percentage.
(可选)在说明框中输入函数的说明。
(可选)对于 python 函数可以采用的每个参数,请单击添加参数按钮(+添加参数)。
每次单击添加参数按钮时,都需要输入参数的名称,并将切换开关设置为参数是否为必填参数。默认情况下,所有参数都不是必需的。
(可选)如果函数中有多个返回值,请单击“ +添加返回列表”。
输入返回值的名称和数据类型,例如整数。
触发器
需要设置的规则定义必需元素是触发器元素。图 5 显示了该system.memory/check-system-memory
规则的触发器块。下面将讨论字段详细信息。
设置触发器涉及创建用于设置策略的术语。如果触发器中的字词匹配,则会执行某些操作。术语可以相互评估规则中定义的字段、函数、变量等,或搜索特定值。术语按从术语列表顶部到底部的顺序进行评估。如果未找到匹配项,则评估下一个术语(如果有),直到找到匹配项或到达术语堆栈的底部。
单击 触发器 链接。
单击添加触发器按钮(+添加触发器)。
将随机触发器名称替换为对要定义的触发器有意义的名称,例如 foo-link-operation-state。建议使用规则和触发器非常唯一的名称,以避免在两个或多个规则中使用相同的触发器名称。
(可选)在 频率 字段中输入一个值。此值告知 Paragon Insights 查询和评估字段数据和触发器的频率。如果未在此处输入,则传感器频率将应用于此值。此处输入的频率可以输入为传感器频率的倍数或偏移量,例如 2o。例如,如果传感器频率为 10s,触发频率为 2o,则触发频率为 20s (2*10s)。
单击添加术语按钮 (+添加术语)。
“术语”区域将展开并显示“时间”部分中的“添加条件”按钮(+ 添加条件),并在“然后”部分中显示“颜色”和“消息”字段。
要定义术语将计算的条件,请单击 + 添加条件 按钮。
“时间”部分将展开以显示“左操作数”、“运算符”和“时间范围”字段。
注意:不需要设置条件。如果要保证 术语 执行特定操作,请不要设置条件。例如,如果您希望指示触发器中的任何术语都不匹配,这可能很有用,例如,在术语堆栈的底部。
从下拉菜单中为每个字段选择值。
根据选择的 运算符 ,新字段 “右操作数 ”可能会出现在 “运算符 ”和 “时间范围 ”字段之间。
左操作数和右操作数下拉菜单填充了规则中定义的字段和变量。运算符字段确定要执行的比较类型。时间范围字段允许触发器评估诸如最后一分钟是否有任何丢弃的数据包等内容。
(可选)设置“颜色”和“消息”字段的值,并在“然后”部分添加操作引擎信息。
这些字段是操作字段。如果在同一项内设置的条件中进行匹配,则会执行您在此处定义的任何操作。可以将颜色值设置为绿色、黄色或红色。也可以设置消息,并且不依赖于是否设置了任何颜色。
从 Paragon Insights 4.2.0 版开始,您可以在设置触发器时将操作工作流(操作引擎)链接到规则。您还可以在链接操作工作流时添加输入参数。 “操作引擎 ”部分仅使用 PIN 高级许可证启用。有关更多信息,请参阅 Paragon Insights 许可概述。
如果设置了颜色或消息,则标记为 “评估下一个术语 ”的切换按钮将显示在 “然后” 部分的底部。此按钮的默认值为关闭(非活动)。
注意:如果在术语的 “时间” 部分中未进行匹配,则忽略 “然后 ”部分。如果发生这种情况,将评估下一个术语(如果有)。
如果在 “时间” 部分中进行了匹配,则会执行“ 然后 ”部分中的操作(如果有),并且除非 “评估下一个术语 ”按钮设置为“开(活动)”,否则将停止处理术语。
通过设置 “评估下一个学期 ”按钮,您可以让 Paragon Insights 进行更复杂的评估,例如“如果一个条件和另一个条件都为真,则执行此操作”。
规则属性
(可选)在 规则属性 块中指定 Paragon Insights 规则的元数据。可用选项包括:
属性 |
描述 |
---|---|
版本 |
输入 Paragon Insights 规则的版本。 |
贡献 |
从下拉列表中选择一个选项。 |
作者 |
指定有效的电子邮件地址。 |
日期 |
从弹出式日历中选择一个日期。 |
支持的 Paragon Insights 版本 |
指定规则有效的最早 Paragon Insights 版本。 |
瞻博网络设备>支持的设备 |
选择 Junos 或 Junos Evolved。设备元数据包括产品名称、版本名称、版本支持(下拉列表)和平台。您可以为多个设备添加元数据,为每个设备添加多个产品,为每个产品添加多个版本。 从 Paragon Insights 4.2.0 版开始,您可以选择要应用于所有受支持设备的默认传感器。您还可以选择要应用于瞻博网络设备和运行特定操作系统的瞻博网络设备的默认传感器。 |
支持的设备>其他供应商设备 |
Paragon Insights 4.1.0 及更早版本 — 您可以为多个设备添加元数据。 Paragon Insights 4.2.0 及更高版本 — 您可以为非瞻博网络供应商添加供应商标识符、供应商名称、产品、平台、版本和操作系统相关信息。 从 Paragon Insights 4.2.0 版开始,您可以选择要应用于所有非瞻博网络设备的默认传感器。 |
帮助程序文件 |
指定 Paragon Insights 规则所需的文件。 |
有关特定硬件平台的 Junos OS 和 Junos OS 演化版软件版本中支持的规则和遥测传感器的详细信息,请参阅 遥测传感器资源管理器。
行动前/行动后
您可以使用以下常规工作流来处理操作前或操作后任务:
配置操作引擎工作流。有关更多信息,请参阅 管理操作引擎工作流 。
根据您的使用案例配置操作前或操作后任务。
使用具有操作前或操作后任务的规则创建剧本。有关更多信息,请参阅 Paragon Insights 规则和剧本 。
在设备组上运行新 playbook 的实例以执行操作前任务。有关更多信息,请参阅 Paragon Insights 规则和剧本 。
停止新剧本的实例以执行操作后任务。有关更多信息,请参阅 Paragon Insights 规则和剧本 。
监视操作前和操作后任务的状态。有关更多信息,请参阅 管理操作引擎工作流 。
在规则中配置操作前和操作后任务之前,必须配置操作引擎工作流。请参阅 管理操作引擎工作流 以配置操作引擎工作流。
要配置操作前任务,请执行以下操作:
单击“规则”页面上的“操作前/操作后”选项卡。
在“操作前”部分中,在“操作引擎”字段中选择操作引擎工作流。
在设备字段中输入列表中的输入参数。该列表显示您之前在所选操作引擎工作流中配置为操作前任务的参数。
如果您希望 Paragon Insights 仅在设备组中的每个设备上执行一次操作前任务,请启用一次执行。
执行下列操作之一:
单击 保存 以保存配置更改,但不部署更新的配置。例如,当您正在进行多项更改并希望以后同时部署所有更新时,可以使用此选项。有关更多信息 ,请参阅 Paragon Insights 中的提交或回滚配置更改 。
单击 保存并部署, 将规则配置保存在 GUI 中并部署配置。当规则包含在剧本中并且剧本实例在设备组上运行时,Paragon Insights 会执行与摄取遥测数据并行的操作前任务。
在规则中配置操作前和操作后任务之前,必须配置操作引擎工作流。请参阅 管理操作引擎工作流 以配置操作引擎工作流。
要配置操作后任务,请执行以下操作:
单击“规则”页面上的“操作前/操作后”选项卡。
在“操作后”部分中,在“操作引擎”字段中选择操作引擎工作流。
在设备字段中输入列表中的输入参数。该列表显示您之前在所选操作引擎工作流中配置为操作后任务的参数。
如果您希望 Paragon Insights 仅在设备组中的每个设备上执行一次操作后任务,请启用执行一次。
执行下列操作之一:
单击 保存 以保存配置更改,但不部署更新的配置。例如,当您正在进行多项更改并希望以后同时部署所有更新时,可以使用此选项。有关更多信息 ,请参阅 Paragon Insights 中的提交或回滚配置更改 。
单击 保存并部署, 将规则配置保存在 GUI 中并部署配置。当您停止 playbook 实例(使用此规则)在设备组上运行时,Paragon Insights 会在停止操作指南服务后执行操作后任务。
编辑规则
要编辑规则:
添加预定义的剧本
瞻博网络精心整理了一套预定义的剧本,旨在解决常见用例。您可以随时将这些操作指南添加到 Paragon Insights 安装中。无法更改或删除默认的预定义剧本。
要向 Paragon Insights 添加预定义的剧本,请执行以下操作:
使用 Paragon Insights GUI 创建新的行动手册
Paragon Insights 基于剧本进行操作,剧本是解决特定客户用例的规则集合。例如,system-kpi-playbook 监控系统参数(如系统-cpu-负载-平均值、存储、系统-内存、进程-内存等)的运行状况,并在任何 KPI 超过预设阈值时通知操作员或采取纠正措施。任何单个规则都可以是 0、1 或多个剧本的一部分。剧本是部署在设备上的规则元素。未包含在任何 playbook 中的规则将不会部署到任何设备。
单击 Playbook 表中的 “名称”、“ 正在运行”、“ 已暂停”或 “概要 ”列标题,以按升序或降序组织数据。
从 4.2.0 版开始,Paragon Insights 在 ICMP 异常值检测手册中支持 splat 运算符。 之前的 icmp 异常值 操作指南要求您输入每个设备的往返时间 (RTT) XPath(使用设备 ID)。由于 playbook 将应用于设备组中的所有设备,因此可以以正则表达式格式输入 splat 运算符 (*),而不是每个设备的设备 ID。
例如:
/device-group[device-group-name=core]/device[device-id=~/.*/]] /topic[topic-name=protocol.icmp]/rule[rule-name=check-icmp-statistics]/rtt-average-ms
如果在运行 ICMP 异常值 playbook 实例的设备组中删除或添加设备,则必须暂停 playbook 实例,修改 XPath 配置以反映设备的添加或删除,然后重新应用设备组的 playbook 实例。
要使用 Paragon Insights GUI 创建新的操作指南,请执行以下操作:
编辑剧本
要编辑剧本:
您无法编辑或删除系统定义(瞻博网络提供)剧本。
更新剧本时,剧本上的新更改将不会应用于剧本的现有实例。例如,编辑或更新剧本时,不会更新与设备组关联的 playbook 实例。必须删除现有 playbook 实例,并创建一个新实例才能应用更新。
克隆剧本
从 HealthBot 3.2.0 版开始,您可以克隆现有剧本并修改配置。
请按照以下步骤使用 Paragon Insights UI 克隆剧本。
管理行动手册实例
术语 playbook 实例是指应用于特定设备组或网络组的 playbook 的特定快照。您可以手动播放和暂停剧本实例。或者,您可以将自定义计划应用于将自动执行播放和暂停操作的 playbook 实例。
以下各节介绍可用于管理 playbook 实例的任务:
查看有关行动手册实例的信息
要查看有关行动手册实例的信息,请执行以下操作:
单击左侧导航栏中的 配置>行动手册 选项。
已保存的剧本列在剧本主页的表格中。
已应用于设备组或网络组的剧本在表中由剧本名称旁边的右插入符号标识。
表中的“实例”列显示正在运行和暂停的 playbook 实例数。
从 HealthBot 3.1.0 版开始,某些操作指南需要购买和安装高级或高级许可证。这些剧本由带有白色星星的绿色圆圈标识。如上所示,当您将鼠标悬停在图标上时,它会告诉您需要哪个许可证。
“实时”列(在表的“操作”部分中)显示一个彩色圆圈指示器,表示每个操作指南的 playbook 实例的总体状态。下表提供了颜色定义:
表 1:实时列的颜色定义 颜色
定义
绿色
与此操作指南关联的所有实例当前都在运行。
黄色
与此剧本关联的一个或多个实例将暂停。
灰色/黑色
没有与此操作指南关联的实例,或者实例与此操作指南关联但尚未部署配置。
单击剧本名称旁边的插入符号以展开或折叠剧本实例详细信息。如果不存在插入符号,则说明该手册尚未应用于任何设备组或网络组。
将显示以下剧本实例详细信息:
列名称或小部件
描述
实例名称
用户定义的实例名称。
附表
应用于 playbook 实例的计划配置文件的名称。有关如何配置计划配置文件的信息,请参阅 创建计划以自动播放/暂停 playbook 实例
单击名称以显示计划详细信息。
设备/网络组
应用计划的设备组或网络组。
不。设备数量
部署此行动指南实例的设备数。这仅适用于设备组实例,不适用于网络组实例。
地位
剧本实例的当前状态。状态可以是“正在运行”或“已暂停”。“状态”列还指示操作是自动执行还是手动执行。
注意:如果 playbook 实例的状态为 “正在运行(自动)”,则可以使用 “暂停计划 ”按钮手动暂停此实例的计划。在这种情况下,状态将更改为 “已暂停(手动)”。要继续运行此实例的计划,您必须使用“ 播放计划 ”按钮手动运行实例。在这种情况下,状态将更改回 “正在运行(自动)”,并且与计划关联的播放和暂停操作将恢复。
开始/暂停时间
上次启动或暂停 playbook 实例的日期和时间。日期反映本地浏览器时区。
下一步行动
此列仅适用于与计划关联的剧本实例。它指示剧本实例是计划为自动暂停还是在将来播放。如果没有计划与 playbook 实例关联,或者实例的状态为 “已暂停(手动)”,则此列为空。
“播放/暂停”按钮
暂停或播放剧本实例或剧本实例的计划。
“播放/暂停”按钮可在两种状态之间切换。有关更多信息,请参阅 手动暂停或播放 playbook 实例。
垃圾桶图标
删除剧本实例。
创建行动手册实例
要为设备组创建 playbook 实例,请执行以下操作:
单击左侧导航栏中的 配置>行动手册 选项。
单击所需操作指南的 “应用 ”图标(在表格的“操作”部分中)。
此时将显示标题为“ 运行剧本:” <playbook-name> 的窗格。
在“ 剧本实例的名称” 字段中,填写此剧本实例的适当名称。这是必填字段。
(可选)在“ 按计划运行 ”字段中,选择要应用于此 playbook 实例的计划的名称。每个 playbook 实例只能应用一个计划。如果希望特定 playbook 实例按多个计划运行,则必须创建该实例的多个版本,每个版本都有其自己唯一的名称和计划。
有关如何配置计划的信息,请参阅 创建计划以自动播放/暂停 playbook 实例。
要查看有关现有计划的信息:
单击左侧导航栏中的 设置 选项。
在 “计划程序设置 ”部分中,表中显示了每个已保存计划的属性摘要。单击特定计划名称以查看其他详细信息。
在“ 设备组 ”部分的 “规则”下,使用下拉列表将此 playbook 实例应用于相应的设备组。
“ 设备 ”部分中的设备列表会根据所选设备组而变化。
注意:如果您的剧本包含网络规则,则不会显示 “设备组 ”部分。相反,它被替换为 “网络组 ”部分(未显示)。
单击“ 设备 ”部分中列出的设备之一。
您可以在此处自定义运行 playbook 时将为此设备设置的变量值。
在标题为“设备的<Device Name>变量值”部分中,可以通过单击规则名称来查看剧本中每个规则的变量。每个变量的默认值在每个字段中显示为灰色文本。您可以保留这些值不变,也可以通过输入新值来覆盖它们。
根据需要对设备组中的每个设备重复步骤 6 和 7。
如果确信所有变量值都适用于设备组中的所有设备,请选择以下选项之一。
保存实例
保存您的编辑内容,但不部署更新的配置,也不运行实例。例如,当您进行多项更改并希望同时部署所有更新时,可以使用此选项。
运行实例
部署配置,如果未应用计划配置文件,请立即运行实例。如果应用了计划配置文件,则实例将根据配置文件的配置运行。
手动暂停或播放剧本实例
当实例暂停时,Paragon Insights 不会收集、分析或针对与剧本规则关联的设备或网络组数据发出警报。暂停实例之前收集的数据将保留在系统中,但在再次播放实例之前,不会收集或分析新数据。
下表描述了在“播放/暂停”列中显示特定按钮时 playbook 实例的状态:
如果显示的播放/暂停按钮是... |
那么剧本实例的状态是... |
---|---|
暂停实例 |
|
暂停时间表 |
|
播放实例 |
|
播放时间表 |
|
要手动暂停 playbook 实例或计划,请执行以下操作:
单击左侧导航栏中的 配置>行动手册 选项。
将显示现有操作指南的列表。
单击要暂停的剧本名称旁边的插入符号。
选择以下选项之一:
单击 “暂停实例 ”按钮以暂停 playbook 实例(不与计划关联)。
单击“ 暂停计划 ”按钮以暂停与 playbook 实例关联的计划。
此时将显示“播放/暂停剧本实例”对话框。选择以下选项之一:
暂停
将此 playbook 实例标记为在下次部署配置时暂停。如果要进行多项更改并希望同时部署所有编辑内容,请使用此选项。
暂停和部署
立即暂停 playbook 实例并部署配置。playbook 表需要几秒钟才能更新以显示实例已暂停。
更新表时略有延迟,因为播放和暂停操作是异步的,并在后台运行,允许您执行其他操作。可以通过位于窗口右上角的部署图标跟踪此异步活动的状态(如部署操作的成功消息所示)。完成此操作后,状态也会反映在剧本表中。
刷新 playbook 表后,playbook 名称会在“实时”列中显示一个黄色图标,作为实例已暂停的可视指示器。
若要恢复已暂停的 playbook 实例,请执行与上述相同的步骤,但为步骤 3 选择以下选项之一除外:
单击“ Play 实例 ”按钮以恢复运行剧本实例(不与计划关联)。
单击“ 播放计划 ”按钮以继续运行与 playbook 实例关联的计划。计划确定实例何时恢复播放。
创建计划以自动播放/暂停 playbook 实例
若要自动播放/暂停 playbook 实例,必须先创建计划,然后将该计划应用于 playbook 实例。每个 playbook 实例只能应用一个计划。如果希望特定 playbook 实例按多个计划运行,则必须创建该实例的多个版本,每个版本都有其自己唯一的名称和计划。
要为 playbook 实例创建计划,请执行以下操作:
单击左侧导航栏中的 “设置>系统 ”选项。
单击 调度程序 选项卡。
在 “计划程序设置”中,单击添加计划程序按钮 (+ 计划程序)。
在文本框中输入必要的值,然后为 playbook 实例计划选择适当的选项。
下表描述了“ 添加计划程序 ”和 “编辑计划程序 ”窗格中的属性:
属性
描述
名字
输入行动指南实例计划的名称。
调度器类型
选择 离散。
您可以使用“ 运行对象 ”字段配置播放 playbook 实例的离散时间长度。运行时间结束后,Paragon Insights 将自动暂停实例。您还可以将 Paragon Insights 配置为使用 “重复 ”字段自动恢复播放实例。
开始于
使用弹出式日历选择首次播放 playbook 实例的日期和时间。
奔跑
配置播放剧本实例的离散时间长度。首先输入一个整数值,然后从下拉列表中选择度量单位(分钟、小时或天)。
运行时间结束后,Paragon Insights 将自动暂停实例。您还可以将 Paragon Insights 配置为使用 “重复 ”字段自动恢复播放实例。
结束于
(可选)使用弹出式日历选择无限期暂停 playbook 实例的日期和时间。如果希望剧本实例无限期播放,请留空。
注意:如果 playbook 实例与计划相关联,并且在达到“ 结束时间 ”时正在运行,则该实例将继续运行,直到达到配置的 运行 时间长度。此时,实例将无限期暂停。
重复
在配置重复字段之前配置 运行对象 字段。“重复”间隔必须大于配置的“运行”时间长度。
在下拉列表中,选择下列选项之一:
您希望剧本实例播放的频率(每天、每周、每月或每年)。
如果希望剧本只播放一次,则 为“从不 ”选项。
自定义选项,用于指定您希望剧本实例播放的自定义频率。使用“重复间隔”字段配置自定义频率。
重复每次
(可选)如果为 “重复 ”字段选择了“自定义”选项,请输入希望 playbook 实例播放的自定义频率。首先输入一个整数值,然后从下拉列表中选择度量单位(分钟、小时或天)。
单击 保存 以保存配置,或单击 保存并部署 以保存并部署配置。
现在,你已准备好将计划应用于 playbook 实例。有关更多信息,请参阅 创建剧本实例。