Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

添加配置模板

在管理门户中,具有 SP(服务提供商)管理员角色(仅本地安装)或 OpCo(运营公司)的用户可通过使用 Jinja 模板语言语法提供设备配置来添加配置模板。

注意:

在版本 5.1.0 之前的 CSO 版本中,配置模板称为阶段-2 配置模板。

  • 如果具有 SP 管理员角色的用户添加了一个模板,则该模板可用于 OpCos、OpCo 的租户和 SP 管理员的租户。

  • 如果具有 OpCo 管理员角色的用户添加了一个模板,则该模板仅适用于 OpCo 和 OpCo 的租户。

注意:
  • 添加配置模板之前,请确保已准备好设备配置。

  • 我们建议您使用工作设备配置来添加配置模板。

要添加配置模板:

  1. 选择 资源>模板>配置模板

    显示配置模板页面。

  2. 单击 + (添加)图标。

    将显示 Add Configuration Template 页面(向导)。

    注意:

    标有星号 (*) 的字段是必填字段。

  3. 根据 表 1 中提供的准则配置基本信息选项卡上的字段。

    单击 Next 转到“模板配置”选项卡。

  4. 在 Templatize Config 选项卡上添加配置。请参阅 表 2 ,了解此选项卡上的操作说明。

    单击 Next 转至 生成的 UI 选项卡,其中将生成和显示您输入参数的 UI。

  5. 表 3 中所述,在此选项卡上执行一个或多个操作。
  6. 单击 保存

    添加了配置模板,您将返回到配置模板页面,其中将显示确认消息。您可以将配置模板分配给设备模板或在设备上部署模板。

表 1:基本信息设置(添加配置模板页面)

设置

指引

模板名称

输入仅包含字母数字字符和连字符的唯一名称:最大 64 个字符。

描述

输入配置模板的说明。

输出配置格式

选择模板的输出配置格式:

  • CLI(默认)

  • Xml

设备系列

选择要添加模板的设备系列;例如瞻博网络-nfx

可以重新部署

如果希望 CSO 在重新部署模板时再次部署配置模板,请启用此切换按钮。即使自上一次部署以来没有配置更改,CSO 也会部署该模板。

如果禁用此按钮(默认设置),则如果自上一次部署以来没有更改,CSO 将不再部署模板。

 

单击 Next 以继续。

表 2:模板配置操作(添加配置模板页面)

行动

描述

查看示例配置

您可通过单击标签顶部附近的 示例配置 链接来查看示例配置。示例配置显示在浏览器的新选项卡中。

添加设备配置

在内联编辑器中,复制和粘贴设备配置,确保语法遵循 Jinja 模板语言。

CSO 检测与您输入的配置对应的模板参数,并在参数窗格中显示这些参数。

有关详细信息,请参阅 Jinja 语法和配置模板示例

高级模式

  • 禁用高级模式(即默认模式)时,CSO 会将您以 Jinja 模板语言输入的配置转换为使用 Junos OS 配置组的 Junos OS 配置。(配置组使配置和维护 Junos OS 配置变得更容易;请参阅 了解 Junos OS 配置组。)CSO 还会自动包含在配置模板中删除配置组的命令。如果触发未部署配置模板工作流程,CSO 将使用这些命令删除配置。因此,为避免与 CSO 自动包含的命令冲突,请确保不会手动包含与配置组相关的命令(作为设备配置的一部分)。

  • 启用高级模式时,CSO 会转换您使用 Jinja 模板语言输入的配置,但不使用 Junos OS 配置组,并且不包含删除配置的命令。因此,如果计划稍后取消部署配置模板,则必须确保您手动输入 命令以删除作为设备配置一部分的配置的配置,以便 CSO 可以使用这些命令删除配置。

[检测到的参数]

检查检测到的参数是否与您添加到模板中的配置匹配:

  • 如果检测到的参数不匹配,请检查您用于模板配置的 Jinja 语法,并在内联编辑器中执行所需的任何更改。

  • 如果检测到的参数与您添加到模板中的配置匹配,请单击 Next 继续。

CSO 验证 Jinja 模板语法,并在出现任何错误时显示错误消息。

表 3:生成的 UI 操作(添加配置模板页面)

行动

描述

重新路由 UI

拖放单个字段、网格或部分以更改参数出现在 UI 上的顺序。

修改字段、部分或网格的设置

要修改字段、部分或网格的设置:

  1. 单击字段、部分或网格旁边的设置(设备)图标。

    参数设置窗格显示在页面右侧,显示基本设置和高级设置选项卡。

  2. 根据需要修改这些选项卡上的字段。请参阅 表 4 ,了解这些选项卡上的字段。

  3. 单击 为每个字段 保存设置 以保存您的更改。

    您所做的修改显示在 UI 上。

重置生成的 UI

单击 撤消所有编辑 以丢弃您做出的更改,并撤消在 UI 上做出的更改。

预览配置

预览配置可让您检查您添加的配置模板。

要预览配置模板:

  1. 单击 预览配置

    显示预览配置页面,显示根据您输入的值呈现的配置。

  2. 检查配置是否已正确呈现。

    • 如果配置未正确呈现,请单击关闭 (X) 图标返回并根据需要进行修改。

    • 如果配置已正确呈现,请单击 OK

    您将返回到生成的 UI 页面。

表 4:参数设置(添加配置模板页面)

设置

指引

基本设置选项卡

此选项卡中填充的字段基于您选择的输入类型。

输入类型

为配置模板中的参数选择输入类型:

  • 文本(默认):如果参数的输入值是一串字符。

  • 编号:如果参数的输入值为编号。

  • 电子邮件:如果参数的输入值是电子邮件地址。

  • IPv4:如果参数的输入值是 IPv4 地址。

  • IPv4 前缀:如果参数的输入值为 IPv4 前缀。

  • IPv6:如果参数的输入值是 IPv6 地址。

  • IPv6 前缀:如果参数的输入值为 IPv6 前缀。

  • 切换按钮 (布尔):如果参数的输入值是布尔值(真或假)。

  • 下拉:如果从列表中选择了参数的输入值。

  • 密码:如果参数的输入值为密码。

    您输入的值为掩码(默认值)。

    (可选)单击 Show Password (眼睛)图标以揭开密码的白令。

  • 确认密码:如果参数的输入值是确认密码。

    如果选择此选项,则 UI 上将显示确认密码字段。您输入的值为掩码(默认值)。

    (可选)单击 Show Password (眼睛)图标以揭开密码的白令。

标签

输入参数所需的标签(在 UI 上)。

默认值

为参数指定默认值。

验证标准

对于文本输入类型,选择一个或多个将检查输入值的验证标准。

如果为 UI 参数输入的值不符合所选验证标准,则会出现错误消息。

描述

输入参数说明,当您在参数的“帮助”(?) 图标上方盘旋时将显示该参数;允许的最大长度为 256 个字符。

全球范围

单击“切换”按钮,使该参数在已部署至的所有设备上通用。如果禁用默认的切换按钮,则必须为每个设备指定参数。

隐藏

预览和部署模板时,单击切换按钮以隐藏 UI 上的参数。

通常,此选项用于隐藏参数并仅在触发事件时将其显示在模板中。默认情况下,禁用切换按钮,这意味着参数将显示。

必填

单击切换按钮,使参数成为必填要求;必须使用 UI 上的星号 (*) 标记参数。

最大值

对于数字参数,输入的最大值(最高 16 位数)。

最低值

对于数字参数,输入的最小值(最高 16 位数)。

可见字段(禁用切换)

对于布尔参数,选择禁用切换按钮时必须在 UI 上显示的一个或多个参数(布尔值是假的)。

可见字段(启用切换)

对于布尔参数,选择启用切换按钮时必须在 UI 上显示的一个或多个参数(布尔值为 TRUE)。

资源类型

对于下拉输入类型,选择要从中检索数据的资源类型:

  • 静态资源 — UI 上列表中的资源映射到您指定的值。

    • 要添加静态资源:

      1. 单击 + (添加)图标。

        信元出现在“列表值”表中。

      2. 单击信元以指定标签(列表中选项的名称)、值(列表中选项的值)和可见性(基于从列表中选择的选项的条件可见性)的值。

      3. 单击 (勾号)保存更改。

        您指定的值显示在“列表值”表中。

    • 要编辑静态资源,请选择资源并单击编辑(铅笔)图标。

    • 要删除静态资源,请选择资源并单击 X (删除)图标。

  • 动态资源 — UI 列表中的资源映射到 CSO 中的预定义服务。

    单击链接 Resource Management 可查看添加、编辑和删除动态资源。Manage Dynamic Resources 页面显示显示现有资源。

    • 要添加动态资源:

      1. 单击 + (添加)图标。

        将显示 Add Dynamic Resource 页面。

      2. 按照 表 5 中指定的准则完成配置。标有星号 (*) 的字段是必填字段。

      3. 单击 OK 保存资源。

        您将返回到 Manage Dynamic Resources 页面,其中将显示您添加的资源。

      4. 单击 OK

        您将返回到 Add Configuration Template 页面。您添加的资源可在参数设置窗格上的 资源 列表中提供。

    • 要编辑动态资源,请选择资源并单击编辑(铅笔)图标。

    • 要删除动态资源,请选择资源并单击 X (删除)图标。

关键

对于表中的数据,从要用作密钥的下拉列表中选择一列。

您选择的列标记为唯一(唯一密钥),表示此列中的条目必须为唯一。

密钥是在 Yang 数据层次结构中定义条目(在表中)中使用的唯一标识符。它们有助于区分列中的条目。

高级设置选项卡

Regexp

输入正则表达式(regex 模式),以验证输入值。

正则表达式定义用于在字符串中匹配字符的搜索模式。

例如,正则表达式 [A-Z] 与字符 A 到 Z 匹配输入。

如果输入由 A 到 Z 以外的字符构成,则会出现错误消息(在无效消息字段中指定)。

错误消息 (Regexp)

输入输入值与指定正则表达式不匹配时,要在 UI 上显示的错误消息。

远程验证

输入 JavaScript 功能验证输入值。

Event List

活动名称

从列表中选择事件,根据该参数有条件显示。

事件处理器

输入 JavaScript 功能,指定事件处理者针对事件采取的操作。

表 5:Add Dynamic Resource 页面上的字段

领域

指引

Data Source

名字

输入该资源的独特名称。

源类型

选择要检索数据的来源:

  • 基于服务,使用预定义服务检索数据。

  • 基于 URL,它使用 API 的 URL 检索数据。

服务

对于基于服务的源类型,选择要从中检索数据的预定义服务。

实体

对于基于服务的源类型,选择要检索数据的实体。

Url

对于基于 URL 的源类型,输入要用于请求的 API 的 URL。

方法

对于基于 URL 的源类型,选择要用于资源的 HTTPS 方法(GET 或 POST)类型。

POST 正文

对于 POST 方法,请输入发送至服务器的 API 方法的有效负载格式(以 JavaScript 对象符号 [JSON] 格式)。

模拟结果

如果 API 请求无法检索数据,请指定模拟结果(JSON 格式)。

Result Mapping

结果映射

选择要根据远程请求的输出完成的处理类型:

  • 脚本 —如果您想使用脚本(JSON 格式)处理输出,请使用此选项。

  • 映射 — 如果您想使用基本路径映射输出,请使用此选项。

映射脚本

要使用脚本处理输出,请输入 JSON 格式的映射脚本。

基本路径

要使用基本路径处理输出,请输入要从中提取数据的输出中的变量的基本路径(JSONPath 表达式):例如接口。

标签字段

选择您是否希望在 UI 上的列表中显示的名称、UUID 或管理状态(对于所选实体)作为选项。

价值字段

选择要与 UI 上列表中的标签(选项)关联的值(例如名称、管理状态等)。

从列表中选择选项并保存配置模板时,CSO 将处理其关联值(在后端)。

额外字段

指定您希望与 UI 上列表中的标签(选项)关联的附加值。从 UI 上的列表中选择选项时,可使用与之关联的附加值使用 JavaScript 功能在符合条件时触发事件。您指定了 Event Handler 字段中的 JavaScript 功能。