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