REST配置

什么是REST配置？

REST API 是一种应用程序编程接口(API或者web API)，它符合REST架构风格的约束，并允许与RESTful网络服务进行交互。在配置方面，大多数设备供应商提供不同级别的REST API支持，用于在备份过程中部分或整体读取和写入设备的配置。

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

在NCM中，基于REST API的配置管理与REST配置命令一起使用。RestT配置命令是配置对象，例如地址、策略、安全规则等。您可以通过进入配置自动化 > 配置命令 > Rest配置命令(在OPM或NFA中，在设置 > NCM > 配置命令 > REST配置命令下提供此选项)。

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

将设备添加到REST API支持

可以按照以下步骤添加支持REST API的设备：

• 进入资源清单 > 设备。
• 单击右上角的添加图标。
• 输入设备的主机名或IP地址。
• 选择设备供应商。
• 为设备选择适当的设备模板。
• 添加系列、型号和自定义列信息(可选)。
• 点击“添加”按钮。

添加设备后，您需要在下一页中提供凭证。您可以仅提供REST凭证，也可以提供CLI和REST凭证的组合。NCM建议结合使用CLI和REST凭证的组合来充分利用该工具。请按照以下步骤将凭证与设备相关联：

• 若要只使用REST凭证，请从协议下拉列表中选择REST API(注意：此选项仅适用于选定的设备模板)。要使用REST和CLI凭证的组合，请选择任何其他协议。
• 对于CLI凭证，请在主要和附加选项卡下提供凭证(如果在第一步中选择了REST API协议，那么这些选项卡将不可用)。
• 要提供REST凭证，请打开REST API选项卡。
• 选择CLI协议后，您需要首先选中此选项卡下使用REST API凭证的选项，进行查看其余参数。请选中“在适用时使用REST API进行通信”复选框。
• 选择连接设备需要使用的协议(http/https)。
• 输入其余所需参数的值(这些参数对于每个设备模板都会有所不同。一些字段将填充默认值，可以根据设备要求进行更改)。
• 点击“保存”按钮。

注意：

• 截至到目前，“保存并测试”选项不适用于REST凭证。
• 目前只对选定的供应商支持REST API，但是会一直尝试支持更多的供应商。
• 如有任何疑问，请通过support@manageengine.cn联系我们的支持团队。

将REST凭证应用到设备

您可以仅提供REST凭证，也可以提供CLI和REST凭证的组合。NCM建议结合使用CLI和REST凭证来充分利用该工具。请按照以下步骤将凭证关联到设备：

• 进入资源清单 > 设备。
• 点击需要与凭证关联的设备凭证图标。或者您也可以选择该设备，并从更多选项中选择“应用凭证”选项。

• 要仅使用REST凭证，请从协议下拉列表中选择REST API(注意：此选项仅适用于选定的设备模板)。要使用REST和CLI凭证的组合，请选择任何其他协议。
• 对于CLI凭证，请在主要和附加选项卡下提供凭证(如果在第一步中选择了REST API协议，那么这些选项卡将不可用)。
• 要提供REST凭证，请打开REST API选项卡。
• 选择CLI协议后，您需要首先选中此选项卡下使用REST API凭证的选项，进行查看其余参数。请选中“在适用时使用REST API进行通信”复选框。
• 选择连接设备需要使用的协议(http/https)。
• 输入其余所需参数的值(这些参数对于每个设备模板都会有所不同。一些字段将填充默认值，可以根据设备要求进行更改)。
• 点击“保存”按钮。

注意：

• 截至到目前，“保存并测试”选项不适用于REST凭证。
• 目前只对选定的供应商支持REST API，但是会一直尝试支持越来越多的设备。
• 如有任何疑问，请通过support@manageengine.cn联系我们的支持团队。

使用REST配置命令的步骤

要使用REST配置文件，您需要先将支持REST API的设备添加到NCM。请点击此处了解有关如何添加设备并将REST凭证与其关联的更多信息。

添加设备并将Rest凭证与设备关联后，您可以使用“配置自动化”选项卡下的REST配置命令页面(对于非 OPM 和 NFA，此页面将位于设置> NCM > 配置命令下)或设备快照页下的“对象资源管理器”选项来使用REST配置命令。要了解什么是REST配置命令，请点击此处。

REST配置命令页面：”

• 请进入配置自动化 > 配置命令 > REST配置命令(仅当您使用NCM时，如果是OPM和NFA，请进入设置 > NCM > 配置命令 > REST配置命令)。
• 您可以通过在供应商标题下的搜索框中输入供应商名称，从而根据您的供应商对配置命令列表进行过滤(如果搜索框不可见，请点击网格标题上的搜索图标搜索图标)。
• 不同供应商的配置命令列表可能会有所不同。
• 每个命令配置本身要么是一个操作，并且只有“执行”操作，要么是来自设备配置的对象(地址、策略、计划等)，并且将具有多个操作(添加、编辑、删除、查看等)。
• 为特定对象选择一个操作并在新打开的页面上提供所需的参数，然后点击执行从而更改设备配置(一些操作是只读的，不会有执行选项。您必须在执行任何操作之前先选择设备。如果有任何更新/删除的操作，请从获取的对象列表中选择一个对象设备)。

对象资源管理器：

• 进入资源清单 > 设备。
• 点击任何设备以打开设备快照页面。
• 如果所选设备支持REST API操作，则在设备快照页面中将显示一个名为对象资源管理器的选项。这是来自设备配置的对象类型的列表(地址、策略、计划等)。
• 一旦从对象资源管理器列表中选择了任何对象类型，就会打开一个新的页面，其中包含所选类型的对象列表。
• 在这里您可以从网格中选择任何对象，然后点击网格右上角的“三条线的图标”，从而查看可以对所选对象执行的操作列表。
• 网格顶部有添加和删除操作(这些操作仅在支持添加和/或删除操作时可用)。
• 一旦选择了操作，将打开新的页面来执行该操作。
• 在新打开的页面中提供所需的参数，然后点击执行(此选项仅在操作不是只读时才可用)。

注意：设备必须启动并运行才能运行任何设备配置命令。

REST配置命令-执行结果

请按照以下步骤检查REST配置命令执行的结果。

• 进入配置自动化 > 配置命令 > REST配置命令历史(对于 OPM 或 NFA，此选项在设置 > NCM > 配置命令 > REST配置命令历史)。
• 在这里，您可以看到配置命令执行列表及其状态。
• 您还可以点击任何行来查看子网格中的更多详细信息。
• 在子网格中，您可以点击pdf或csv图标来获取包含设备响应的报表。
• 或者您可以点击子网格行来打开带有设备响应的页面，并查看执行前后对象值之间的差异(差异仅在编辑的情况下可用)。

如何检查NCM是否支持我设备的REST操作？

请进入配置自动化 > 设备模板 > REST设备模板并查看是否有可用于您设备的模板。如果有可用的模板，那么您可以在该特定设备上使用NCM执行REST操作。对于OpManager和NFA，此页面位于设置 > NCM REST设备模板下。

请注意：确保设备的固件版本高于或等于基本操作系统版本，以便REST操作正常工作。

REST配置命令-优势

• 在备份整个配置时，REST API比普通的CLI备份要快得多。事实上，所有REST API操作通常都比CLI操作更快。
• 在更新配置的特定部分时，不必记住命令语法。
• 不必担心配置中对象的层次结构。
• 配置中的重要对象可以在NCM中以网格的格式进行查看。
• NCM的REST配置命令功能提供了一个类似于设备的GUI(例如：防火墙GUI)，这使得直接从NCM更新部分配置变得容易。