Table of Contents
> 主机接口 object
以下objects与hostinterfaceAPI直接相关。
主机接口
主机接口object具有以下属性。
注意：IP和DNS均为必填项。若无需使用DNS，请将其设置为空string。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| available | integer | （只读） 主机接口的可用性状态。 可选值为： 0 - （默认） 未知； 1 - 可用； 2 - 不可用。 |
| details | array | 接口的附加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地址连接。 |
请注意：部分方法（如更新、删除）对必填/选填参数的组合要求有所不同。
详情标签
详情object具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| version (required) |
integer | SNMP接口版本。 可选值为： 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接口。 |