Table of Contents
> 主机接口 object
以下objects与hostinterface API直接相关.
主机接口
主机 接口 object 具有以下属性。
注意IP和DNS均为必填项。若您 不想使用DNS，请将其设为空 string。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| available | integer | (只读) 主机 接口的可用性。 可能值为: 0 - (默认) 未知; 1 - 可用; 2 - 不可用。 |
| details | object | 接口的附加 object。当接口 '类型' 为SNMP时必填。 |
| disable_until | timestamp | (只读) 不可用 主机 接口的下次轮询时间。 |
| dns (required) |
string | 接口使用的DNS名称。 若通过IP连接可留空。 |
| error | string | (只读) 当 主机 接口不可用时的错误文本。 |
| errors_from | timestamp | (只读) 主机 接口变为不可用的时间。 |
| hostid (required) |
string | 接口所属 主机 的ID。 |
| interfaceid | string | (只读) 接口的ID。 |
| ip (required) |
string | 接口使用的IP地址。 若通过DNS连接可留空。 |
| main (required) |
integer | 是否作为 主机 的默认接口。每种类型接口在 一个主机 上只能设置一个默认项。 可能值为: 0 - 非默认; 1 - 默认。 |
| port (required) |
string | 接口使用的端口号。可包含用户宏。 |
| type (required) |
integer | 接口类型。 可能值为: 1 - agent; 2 - SNMP; 3 - IPMI; 4 - JMX。 |
| useip (required) |
integer | 是否应通过IP建立连接。 可能值为: 0 - 使用 主机DNS名称 连接; 1 - 为此 主机 接口使用 主机IP地址 连接。 |
注意对于某些方法(update, delete)，必填/可选参数的组合会有所不同。
详情标签
该 object 具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| version (required) |
integer | SNMP 接口 version. 可能值为: 1 - SNMPv1; 2 - SNMPv2c; 3 - SNMPv3 |
| bulk | integer | 是否使用批量 SNMP 请求. 可能值为: 0 - 不使用批量请求; 1 - (默认) - 使用批量请求. |
| community | string | SNMP 共同体字符串(必需). 仅用于 SNMPv1 和 SNMPv2 接口. |
| securityname | string | SNMPv3 安全名称. 仅用于 SNMPv3 接口. |
| securitylevel | integer | SNMPv3 安全级别. 仅用于 SNMPv3 接口. 可能值为: 0 - (默认) - 无认证无加密; 1 - 认证无加密; 2 - 认证加密. |
| 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 接口. |