基于REST API的配置管理

REST API是一个应用程序编程接口(API或Web API),它符合REST体系结构样式的约束,并允许与RESTful Web服务进行交互。在配置方面,大多数设备供应商在备份过程中以零件或整体读取设备配置的不同级别提供REST API支持。

Network Configuration Manager使用REST API允许用户获得简化的UI体验。用户可以专注于配置的特定部分,而不必担心命令语法和配置层次结构。最重要的是,REST API的GUI被设计为与设备GUI类似,以便用户更好地理解。

基于REST API的配置管理支持

为Fortigate和Palo Alto防火墙提供了基于REST API的配置管理支持。我们正在努力为更多设备提供支持。Juniper和Arista设备正在进行中,Cisco FTD将紧随其后。如果您希望我们为特定供应商添加支持,可以通过邮件的方式与我们的技术人员进行沟通,其邮箱为support@manageengine.cn。

适用于REST配置文件的基于REST API的配置管理。

基于REST API的配置管理对基于CLI的配置管理的好处:

  • 在备份整个配置时,REST API速度更快。
  • 用户在更新配置的特定部分时不必记住命令语法。
  • 用户不必担心配置中对象的层次结构。
  • 可以在Network Configuration Manager中以网格格式查看配置中的重要对象。
  • REST API提供了一个GUI,它类似于设备的GUI,例如:防火墙GUI,这可以轻松地直接从Network Configuration Manager更新部分配置。

REST凭证

要使用REST API功能,Network Configuration Manager在执行REST API之前需要REST凭证才能连接到设备。这些凭证可以直接从“应用凭证”页面中提供。

  • 每个供应商都需要在与REST API以及身份验证参数连接时要设置不同的参数。
  • Network Configuration Manager在同一凭证页面中,基于供应商的默认值提供了每个参数的字段。
  • 您可以选择只使用REST凭证或结合CLI和REST凭证来管理设备。
  • 对于启用/禁用syslog变更检测等重要功能,建议结合CLI和REST凭证来管理设备。

请参考以下步骤和屏幕截图,从而了解有关将REST凭证与特定设备相关联的更多信息。

  1. 前往资源清单 > 设备。
  2. 选择要应用REST凭证的设备。
  3. 从选项中选择“应用凭证”。
  4. 如果您想只使用REST凭证管理设备,请选择“REST API”作为协议。否则选择所需的协议,提供适当的CLI凭证,然后选择"REST API"选项卡来提供REST凭证。
  5. 检查“随时使用REST API进行通信”。(这仅在使用REST凭证和CLI协议时可用)
  6. 提供表格中的所有必需参数并保存凭证。

REST Configlets

Rest Configlets是配置对象,例如地址、策略、安全规则等。您可以通过进入配置自动化>配置命令>REST Configlets来对其进行访问。

每个Configlets都附带一组不同的操作,例如添加、编辑、查看、删除、重命名、查看全部、克隆、执行等。

操作描述
添加向设备配置添加新对象。
编辑提供设备中可用对象的列表。之后用户可以选择一个特定的对象,详细信息将从设备中获取并显示给用户。用户可以更新该对象的任何特定细节/参数,然后执行Configlet来将更改保存在设备中。
查看提供设备中可用对象的列表。之后用户可以选择一个特定的对象,其详细信息将从设备中获取并以只读模式显示给用户。
查看全部在网格中显示设备中的所有可用对象及其详细信息
删除提供设备中可用对象的列表。用户可以选择特定对象并执行Configlet来删除该对象。
重命名用户可以选择特定对象并提供新名称来重命名设备上的对象。
克隆用户可以选择一个特定的对象并提供一个新名称,从而使用提供的名称及其属性在设备中克隆该对象。
执行大多数非防火墙设备都有只能作为CLI命令查看和执行的对象。对于这样的设备和配置对象,只有一种操作可用,即“执行”。它将使用提供的参数在设备中执行命令。