添加配置模板
在管理门户中,具有 SP(服务提供商)管理员角色(仅限本地安装)或 OpCo(运营公司)管理员角色的用户可以通过使用 Jinja 模板语言语法提供设备配置来添加配置模板。
在 5.1.0 版之前的 CSO 版本中,配置模板称为阶段 2 配置模板。
如果具有 SP 管理员角色的用户添加了模板,则该模板可供 OpCos、OpCo 的租户和 SP 管理员的租户使用。
如果具有 OpCo 管理员角色的用户添加了模板,则该模板仅可供 OpCo 和 OpCo 的租户使用。
在添加配置模板之前,请确保已准备好设备配置。
我们建议您使用工作设备配置来添加配置模板。
要添加配置模板,请执行以下操作:
设置 |
指引 |
---|---|
模板名称 |
输入只能包含字母数字字符和连字符的唯一名称;最多 64 个字符。 |
描述 |
输入配置模板的说明。 |
输出配置格式 |
选择模板的输出配置格式:
|
设备系列 |
选择要为其添加模板的设备系列;例如,Juniper-NFX。 |
可以重新部署 |
如果您希望 CSO 在重新部署模板时再次部署配置模板,请启用此切换按钮。CSO 会部署模板,即使自上次部署以来没有配置更改也是如此。 如果禁用此按钮(默认设置),则自上次部署以来没有任何更改,CSO 不会再次部署模板。 |
单击 下一步 继续。 |
行动 |
描述 |
---|---|
查看示例配置 |
您可以通过单击选项卡顶部附近的示例配置链接来查看示例 配置 。示例配置将显示在浏览器的新选项卡中。 |
添加设备配置 |
在内联编辑器中,复制并粘贴设备配置,确保语法遵循 Jinja 模板语言。 CSO 检测与您输入的配置对应的模板参数,并将其显示在“参数”窗格中。 有关更多信息,请参阅 Jinja 语法和配置模板示例。 |
高级模式 |
|
[检测到的参数] |
检查检测到的参数是否与您添加到模板的配置匹配:
CSO 验证 Jinja 模板语法,如果有任何错误,则显示错误消息。 |
行动 |
描述 |
---|---|
对 UI 重新排序 |
拖放单个字段、网格或部分以更改参数在 UI 上的显示顺序。 |
修改字段、部分或网格的设置 |
修改字段、节或网格的设置:
|
重置生成的 UI |
单击 撤消所有编辑 以放弃所做的更改并撤消在 UI 上所做的更改。 |
预览配置 |
通过预览配置,可以检查添加的配置模板。 要预览配置模板:
|
设置 |
指引 |
---|---|
“基本设置”选项卡 |
此选项卡中填充的字段基于您选择的输入类型。 |
输入类型 |
在配置模板中选择参数的输入类型:
|
标签 |
输入要为参数显示(在 UI 上)的标签。 |
默认值 |
指定参数的默认值。 |
验证标准 |
对于文本输入类型,选择一个或多个验证条件,以检查输入值。 如果在 UI 上为参数输入的值不符合所选验证条件,则会显示一条错误消息。 |
描述 |
输入参数的说明,当您将鼠标悬停在参数的帮助 (?) 图标上时,将显示该说明;允许的最大长度为 256 个字符。 |
全球范围 |
单击切换按钮,使参数在配置模板部署到的所有设备中通用。如果禁用切换按钮(默认设置),则必须为每个设备指定参数。 |
隐藏 |
单击切换按钮可在预览和部署模板时隐藏 UI 上的参数。 通常,此选项用于隐藏参数,并仅在触发事件时才在模板中显示该参数。默认情况下,切换按钮处于禁用状态,这意味着将显示参数。 |
必填 |
单击切换按钮使参数成为必填项;必需的参数在 UI 上用星号 (*) 标记。 |
最大值 |
对于数字参数,请输入输入的最大值(最多 16 位数字)。 |
最小值 |
对于数字参数,请输入输入的最小值(最多 16 位)。 |
可见字段(切换已禁用) |
对于布尔参数,请选择禁用切换按钮时必须在 UI 上显示的一个或多个参数(布尔值为 FALSE)。 |
可见字段(启用切换) |
对于布尔参数,请选择启用切换按钮时必须在 UI 上显示的一个或多个参数(布尔值为 TRUE)。 |
资源类型 |
对于“下拉列表输入类型”,选择要从中检索数据的资源类型:
|
关键 |
对于表中的数据,请从下拉列表中选择要用作键的列。 您选择的列标记为唯一(唯一键),指示此列中的条目必须是唯一的。 键是用于定义 Yang 数据层次结构中的条目(在表中)的唯一标识符。它们有助于区分列中的条目。 |
“高级设置”选项卡 |
|
Regexp |
输入正则表达式(正则表达式模式)以验证输入值。 正则表达式定义用于匹配字符串中的字符的搜索模式。 例如,正则表达式 [A-Z] 将输入与字符 A 到 Z 匹配。 如果输入由 A 到 Z 以外的字符组成,则会显示一条错误消息(在“无效消息”字段中指定)。 |
错误消息 (正则表达式) |
输入当输入值与指定的正则表达式不匹配时要在 UI 上显示的错误消息。 |
远程验证 |
输入 JavaScript 函数来验证输入值。 |
Event List |
|
事件名称 |
从列表中选择一个事件,并基于该事件有条件地显示参数。 |
事件处理程序 |
输入一个 JavaScript 函数,该函数指定事件处理程序为响应事件而执行的操作。 |
领域 |
指引 |
---|---|
Data Source |
|
名字 |
输入资源的唯一名称。 |
源类型 |
选择要从中检索数据的源:
|
服务 |
对于基于服务的源类型,选择要从中检索数据的预定义服务。 |
实体 |
对于基于服务的源类型,选择要为其检索数据的实体。 |
Url |
对于基于 URL 的源类型,请输入要用于请求的 API 的 URL。 |
方法 |
对于基于 URL 的源类型,请选择要用于资源的 HTTPS 方法的类型(GET 或 POST)。 |
开机自检正文 |
对于 POST 方法,请输入发送到服务器的 API 方法的有效负载格式(JavaScript 对象表示法 [JSON] 格式)。 |
模拟结果 |
如果 API 请求无法检索数据,请指定模拟结果(JSON 格式)。 |
Result Mapping |
|
结果映射 |
选择要对远程请求的输出执行的处理类型:
|
映射脚本 |
若要使用脚本处理输出,请输入 JSON 格式的映射脚本。 |
基本路径 |
要使用基路径处理输出,请在要从中提取数据的输出中输入变量的基本路径(JSONPath 表达式);例如,接口。 |
标签字段 |
选择是否要将名称、UUID 或管理状态(对于所选实体)显示为 UI 列表中的选项。 |
值字段 |
选择要与 UI 列表中的标签(选项)关联的值(如名称、管理状态等)。 从列表中选择选项并保存配置模板时,CSO 会处理其关联值(在后端)。 |
额外字段 |
指定要与 UI 列表中的标签(选项)关联的其他值。从 UI 上的列表中选择选项时,可以使用 JavaScript 函数在满足条件时使用其关联的附加值来触发事件。您可以在“事件处理程序”字段中指定 JavaScript 函数。 |