配置 API - 添加、更新和移除 staticHost

我们强烈建议您在开始使用 Cato API 之前，请查看 Cato API 支持政策。

本文解释了如何使用 Cato API 来管理为站点定义的主机，命令如下：

addStaticHost
updateStaticHost
removeStaticHost

staticHost 概述

使用 staticHost 变更 API 在您的账户中为站点添加、更新和移除主机，并为主机定义以下设置：

主机的名称
主机的 IP 地址
MAC 地址（可选 - 用于为主机保留 DHCP IP 分配）

对于经销商账户，您可以在每个客户账户内创建单独的 API 密钥，以便使用 Cato API 配置设置。

定位站点的 siteID

站点 ID 不显示在 Cato 管理应用中，您可以定位站点 ID：

使用 entityLookup API 查询（请参阅 Cato API - EntityLookup），使用值为 site 的 type

您还可以使用值为站点名称的 search 参数，查询返回站点 ID
当您选择一个站点（网络 > 站点 > {site name}）时，Cato 管理应用的 URL 中的数字。例如，以下 URL 的站点 ID 为 12345：https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

addStaticHost 和 updateStaticHost 参数的详细信息

创建或更新站点后面的主机时，使用相同的参数，使用 Cato 配置 API。对于 addStaticHost，除非标记为可选，否则参数是强制性的。对于 updateStaticHost，包含您要更新的主机设置参数。

hostId - 对于 updateStaticHost，输入您正在更新的主机的 ID

对于 addStaticHost，新主机创建时生成此 ID
name - 站点后面主机的名称
ip - 站点后面主机的 IP 地址
macAddress - （可选）站点后面主机的 MAC 地址

主机的 MAC 地址用于为具有静态 IP 地址的主机预留 DHCP

StaticHost hostId

hostId 是主机实体的内部 Cato ID。

networkRangeId 可以使用只读的 entityLookup API 检索，使用值为 host 的 type

StaticHost name

使用 name 参数定义主机的名称。

StaticHost ip

使用 ip 参数定义主机的 IP 地址。

StaticHost macAddress (Optional)

使用 macAddress 参数定义主机的 MAC 地址以进行 DHCP 预留。

对于使用 Cato 作为 DHCP 服务器的账户，定义了 MAC 地址的主机的 IP 地址会被保留，无法分配给其他主机。确保主机的 IP 地址不在为站点定义的网络段的 DHCP 范围内。

removeStaticHost

使用 removeStaticHost API 删除为站点定义的主机。您只需要在此 API 中使用 hostId。

Postman 脚本示例

mutation addStaticHost ($accountId: ID!, $siteId: ID!, $input:AddStaticHostInput!) {
 site(accountId: $accountId) {
 addStaticHost(
 siteId: $siteId, 
 input: $input
 ) {
 hostId
 }
 }
}

GraphQL 变量

{
 "accountId": "26",
 "siteId": 126,
 "input": {
 "primaryManagementIp": "192.168.4.2",
 "secondaryManagementIp": "192.168.4.3",
 "vrid": 100
 }
}

相关资源