Documentation
Table of Contents
主机 接口 object
以下 objects 直接与 hostinterface API 相关。
主机接口
主机接口object具有以下属性。
请注意，ip和dns属性对于create操作都是必需的。 如果不想使用DNS，请将其设置为空string。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| interfaceid | ID | 接口的ID。 属性行为: - 只读 - 对于update操作是必需的 |
| available | integer | 主机接口的可用性。 可能的值： 0 - (默认) 未知； 1 - 可用； 2 - 不可用。 属性行为: - 只读 |
| hostid | ID | 接口所属的主机的ID。 属性行为: - 常量 - 对于create操作是必需的 |
| type | integer | 接口类型。 可能的值： 1 - Agent； 2 - SNMP； 3 - IPMI； 4 - JMX。 属性行为: - 对于create操作是必需的 |
| ip | string | 接口使用的IP地址。 如果通过DNS连接，可以为空。 属性行为: - 对于create操作是必需的 |
| dns | string | 接口使用的DNS名称。 如果通过IP连接，可以为空。 属性行为: - 对于create操作是必需的 |
| port | string | 接口使用的端口号。 可以包含用户宏。 属性行为: - 对于create操作是必需的 |
| useip | integer | 是否应通过IP进行连接。 可能的值： 0 - 使用主机DNS名称连接； 1 - 使用主机IP地址连接。 属性行为: - 对于create操作是必需的 |
| main | integer | 接口是否在主机上作为默认接口。在一个主机上，每种类型的接口只能有一个设置为默认。 可能的值： 0 - 非默认； 1 - 默认。 属性行为: - 对于create操作是必需的 |
| details | object | 接口的额外详情object。 属性行为: - 如果 type设置为"SNMP"，则是必需的 |
| disable_until | timestamp | 不可用的主机接口的下一次轮询时间。 属性行为: - 只读 |
| error | string | 如果主机接口不可用时的错误文本。 属性行为: - 只读 |
| errors_from | timestamp | 主机接口变为不可用的时间。 属性行为: - 只读 |
详情
详细信息 object 具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| version | integer | SNMP 接口版本。 可能的值： 1 - SNMPv1； 2 - SNMPv2c； 3 - SNMPv3。 属性行为： - 必填 |
| bulk | integer | 是否使用批量 SNMP 请求。 可能的值： 0 - 不使用批量请求； 1 - （默认）- 使用批量请求。 |
| community | string | SNMP 团体名。仅用于 SNMPv1 和 SNMPv2 接口。 属性行为： - 如果 version 设置为 "SNMPv1" 或 "SNMPv2c"，则为必填 |
| max_repetitions | integer | 原生 SNMP 批量请求（GetBulkRequest-PDUs）的最大重复值。 仅用于 SNMPv2 和 v3 中的 discovery[] 和 walk[] 监控项。默认值：10。 |
| securityname | string | SNMPv3 安全名称。仅用于 SNMPv3 接口。 |
| securitylevel | integer | SNMPv3 安全级别。仅用于 SNMPv3 接口。 可能的值： 0 - （默认）- noAuthNoPriv； 1 - authNoPriv； 2 - authPriv。 |
| authpassphrase | string | SNMPv3 认证口令。仅用于 SNMPv3 接口。 |
| privpassphrase | string | SNMPv3 隐私口令。仅用于 SNMPv3 接口。 |
| authprotocol | integer | SNMPv3 认证协议。仅用于 SNMPv3 接口。 可能的值： 0 - （默认）- MD5； 1 - SHA1； 2 - SHA224； 3 - SHA256； 4 - SHA384； 5 - SHA512。 |
| privprotocol | integer | SNMPv3 隐私协议。仅用于 SNMPv3 接口。 可能的值： 0 - （默认）- DES； 1 - AES128； 2 - AES192； 3 - AES256； 4 - AES192C； 5 - AES256C。 |
| contextname | string | SNMPv3 上下文名称。仅用于 SNMPv3 接口。 |