# > Host object 主机对象

The following objects are directly related to the host
API.以下是主机API的使用方法。

### Host 主机

The host object has the following properties.主机对象拥有以下属性。

|属性                   类|说明|<|
|----------------------------|------|-|
|hostid|string|*(readonly)* ID of the host. （只读）主机的ID。|
|**host**<br>(required)|string|Technical name of the host. 主机的正式名称。|
|available|integer|*(readonly)* Availability of Zabbix agent. （只读）Zabbix agent的可用性。<br><br>Possible values are:可能的值为：<br>0 - *(default)* unknown;（默认）未知；<br>1 - available; 可用；<br>2 - unavailable.失效|
|description|text|Description of the host.主机说明。|
|disable\_until|timestamp|*(readonly)* The next polling time of an unavailable Zabbix agent.只读）对失效Zabbix agent下一次的轮询时间。|
|error|string|*(readonly)* Error text if Zabbix agent is unavailable.（只读）Zabbix agent失效的错误文本。|
|errors\_from|timestamp|*(readonly)* Time when Zabbix agent became unavailable.（只读）当Zabbix agent失效时的时间。|
|flags|integer|*(readonly)* Origin of the host. （只读）主机的来源。<br><br>Possible values: 可能的值为：<br>0 - a plain host; 普通主机；<br>4 - a discovered host.自动发现的主机。|
|inventory\_mode|integer|Host inventory population mode.主机资产清单群体模式。<br><br>Possible values are: 可能的值：<br>-1 - disabled; 已禁用；<br>0 - *(default)* manual;（默认）手动；<br>1 - automatic. 自动。|
|ipmi\_authtype|integer|IPMI authentication algorithm.IPMI认证算法。<br><br>Possible values are:可能的值为：<br>-1 - *(default)* default; （默认）默认；<br>0 - none;无；<br>1 - MD2;<br>2 - MD5<br>4 - straight; 直连；<br>5 - OEM;原厂；<br>6 - RMCP+. 远程管理控制协议。|
|ipmi\_available|integer|*(readonly)* Availability of IPMI agent. （只读）IPMI agent的可用性。<br><br>Possible values are:可能的值为：<br>0 - *(default)* unknown;（默认）未知；<br>1 - available;可用；<br>2 - unavailable. 失效。|
|ipmi\_disable\_until|timestamp|*(readonly)* The next polling time of an unavailable IPMI agent. （只读）对失效IPMI agent下一次的轮询时间。|
|ipmi\_error|string|*(readonly)* Error text if IPMI agent is unavailable. （只读）IPMI agent失效的错误文本。|
|ipmi\_errors\_from|timestamp|*(readonly)* Time when IPMI agent became unavailable.（只读）当IPMI agent失效时的时间。|
|ipmi\_password|string|IPMI password.IPMI密码。|
|ipmi\_privilege|integer|IPMI privilege level. IPMI特权级别。<br><br>Possible values are:可能的值为：<br>1 - callback;回调；<br>2 - *(default)* user;（默认）用户；<br>3 - operator;操作员；<br>4 - admin;管理员；<br>5 - OEM. 原厂。|
|ipmi\_username|string|IPMI username. IPMI用户名。|
|jmx\_available|integer|*(readonly)* Availability of JMX agent. （只读）JMX agent的可用性。<br><br>Possible values are:可能的值为：<br>0 - *(default)* unknown;（默认）未知；<br>1 - available;可用；<br>2 - unavailable.失效。|
|jmx\_disable\_until|timestamp|*(readonly)* The next polling time of an unavailable JMX agent.（只读）对失效JMX agent下一次的轮询时间。|
|jmx\_error|string|*(readonly)* Error text if JMX agent is unavailable. （只读）JMX失效的错误文本。|
|jmx\_errors\_from|timestamp|*(readonly)* Time when JMX agent became unavailable. （只读）当JMX agent失效时的时间。|
|maintenance\_from|timestamp|*(readonly)* Starting time of the effective maintenance. （只读）开始有效管理的时间。|
|maintenance\_status|integer|*(readonly)* Effective maintenance status.（只读）有效管理的状态。<br><br>Possible values are:可能的值为：<br>0 - *(default)* no maintenance;（默认）管理断开；<br>1 - maintenance in effect.管理有效。|
|maintenance\_type|integer|*(readonly)* Effective maintenance type. （只读）有效管理的类型。<br><br>Possible values are:可能的值为：<br>0 - *(default)* maintenance with data collection;（默认）有数据收集的管理；<br>1 - maintenance without data collection. 没有数据收集的管理。|
|maintenanceid|string|*(readonly)* ID of the maintenance that is currently in effect on the host.（只读）当前对主机起效的管理ID。|
|name|string|Visible name of the host. 主机显示名称。<br><br>Default: `host` property value. 默认：host属性值。|
|proxy\_hostid|string|ID of the proxy that is used to monitor the host. 用于监控主机的代理服务器 ID。|
|snmp\_available|integer|*(readonly)* Availability of SNMP agent. （只读）SNMP agent的可用性。<br><br>Possible values are:可能的值为：<br>0 - *(default)* unknown;（默认）未知；<br>1 - available;可用；<br>2 - unavailable. 失效。|
|snmp\_disable\_until|timestamp|*(readonly)* The next polling time of an unavailable SNMP agent.（只读）对失效SNMP agent下一次的轮询时间。|
|snmp\_error|string|*(readonly)* Error text if SNMP agent is unavailable.（只读）SNMP agent失效的错误文本。|
|snmp\_errors\_from|timestamp|*(readonly)* Time when SNMP agent became unavailable. （只读）当SNMP agent失效时的时间。|
|status|integer|Status and function of the host. 主机的状态和功能。<br><br>Possible values are:可能的值为：<br>0 - *(default)* monitored host;（默认）已监控主机；<br>1 - unmonitored host.未监控主机|
|tls\_issuer|string|Certificate issuer. 证书颁布。|
|tls\_subject|string|Certificate subject.证书标题。|
|tls\_psk\_identity|string|PSK identity. Required if either `tls_connect` or `tls_accept` has PSK enabled. PSK身份，若要启用tls\_connect或tls\_accept，就必须启用PSK。|
|tls\_psk|string|The preshared key, at least 32 hex digits. Required if either `tls_connect` or `tls_accept` has PSK enabled. PSK至少需要32位16进制数字构成。若要启用tls\_connect或tls\_accept，就必须启用PSK。|

### Host inventory 主机资产清单

The host inventory object has the following properties.
主机资产清单对象有以下属性。

::: notetip
Each property has it's own unique ID number, which is
used to associate host inventory fields with
items.每一个属性拥有自己唯一的ID编号，用于将主机资产清单字段和事项关联在一起。
:::

|ID|属性                 类|说明|<|
|--|--------------------------|------|-|
|4|alias|string|Alias.别名|
|11|asset\_tag|string|Asset tag.资产编号。|
|28|chassis|string|Chassis. 机架。|
|23|contact|string|Contact person.联系人。|
|32|contract\_number|string|Contract number.联系号码。|
|47|date\_hw\_decomm|string|HW decommissioning date. 硬件淘汰时间。|
|46|date\_hw\_expiry|string|HW maintenance expiry date. 硬件维保过期时间。|
|45|date\_hw\_install|string|HW installation date. 硬件安装时间。|
|44|date\_hw\_purchase|string|HW purchase date.硬件购买时间。|
|34|deployment\_status|string|Deployment status. 部署状态。|
|14|hardware|string|Hardware. 硬件设备。|
|15|hardware\_full|string|Detailed hardware.硬件设备详情。|
|39|host\_netmask|string|Host subnet mask. 主机子网掩码。|
|38|host\_networks|string|Host networks.主机网络。|
|40|host\_router|string|Host router.主机路由。|
|30|hw\_arch|string|HW architecture.硬件架构。|
|33|installer\_name|string|Installer name. 安装人员姓名。|
|24|location|string|Location. 地点。|
|25|location\_lat|string|Location latitude. 纬度位置。|
|26|location\_lon|string|Location longitude.经度位置。|
|12|macaddress\_a|string|MAC address A. MAC地址一。|
|13|macaddress\_b|string|MAC address B. MAC地址二。|
|29|model|string|Model. 型号。|
|3|name|string|Name. 名称。|
|27|notes|string|Notes. 注释。|
|41|oob\_ip|string|OOB IP address. 带外IP地址。|
|42|oob\_netmask|string|OOB host subnet mask.带外主机子网掩码。|
|43|oob\_router|string|OOB router. 带外路由。|
|5|os|string|OS name.操作系统名称。|
|6|os\_full|string|Detailed OS name. 详尽操作系统名称。|
|7|os\_short|string|Short OS name. 简短操作系统名称。|
|61|poc\_1\_cell|string|Primary POC mobile number.主POC移动号码。|
|58|poc\_1\_email|string|Primary email. 主POC邮箱。|
|57|poc\_1\_name|string|Primary POC name. 主POC名称。|
|63|poc\_1\_notes|string|Primary POC notes. 主POC注释。|
|59|poc\_1\_phone\_a|string|Primary POC phone A.主POC电话一。|
|60|poc\_1\_phone\_b|string|Primary POC phone B. 主POC电话二。|
|62|poc\_1\_screen|string|Primary POC screen name. 主POC显示名。|
|68|poc\_2\_cell|string|Secondary POC mobile number. 次POC移动号码。|
|65|poc\_2\_email|string|Secondary POC email. 次POC邮箱。|
|64|poc\_2\_name|string|Secondary POC name. 次POC名称。|
|70|poc\_2\_notes|string|Secondary POC notes. 次POC注释。|
|66|poc\_2\_phone\_a|string|Secondary POC phone A.次POC电话一。|
|67|poc\_2\_phone\_b|string|Secondary POC phone B. 次POC电话二。|
|69|poc\_2\_screen|string|Secondary POC screen name. 次POC显示名。|
|8|serialno\_a|string|Serial number A. 序列号一。|
|9|serialno\_b|string|Serial number B. 序列号二。|
|48|site\_address\_a|string|Site address A. 所在地址一。|
|49|site\_address\_b|string|Site address B. 所在地址二。|
|50|site\_address\_c|string|Site address C. 所在地址三。|
|51|site\_city|string|Site city.所在城市。|
|53|site\_country|string|Site country. 所在国家。|
|56|site\_notes|string|Site notes. 所在地注解。|
|55|site\_rack|string|Site rack location. 所在地机柜位置|
|52|site\_state|string|Site state.所在地说明。|
|54|site\_zip|string|Site ZIP/postal code. 所在地邮政编码。|
|16|software|string|Software.软件。|
|18|software\_app\_a|string|Software application A. 应用软件一。|
|19|software\_app\_b|string|Software application B. 应用软件二。|
|20|software\_app\_c|string|Software application C. 应用软件三。|
|21|software\_app\_d|string|Software application D. 应用软件四。|
|22|software\_app\_e|string|Software application E. 应用软件五。|
|17|software\_full|string|Software details. 软件详情。|
|10|tag|string|Tag. 标签。|
|1|type|string|Type. 类型。|
|2|type\_full|string|Type details. 具体类型。|
|35|url\_a|string|URL A.网址一。|
|36|url\_b|string|URL B. 网址二。|
|37|url\_c|string|URL C.网址三。|
|31|vendor|string|Vendor. 供应商。|