[comment]: # aside:1 [comment]: # ({70b8d6b4-b7ea8d04}) # Host object The following objects are directly related to the host API. [comment]: # ({/70b8d6b4-b7ea8d04}) [comment]: # ({7d75bf76-2f6c5c76}) ### Host The host object has the following properties. |Property|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |hostid|ID|ID of the host.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*
- *required* for update operations| |host|string|Technical name of the host.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* for create operations| |description|text|Description of the host.| |flags|integer|[Origin](/manual/api/reference_commentary#entity-origin-flags) of the host.

Possible values:
0 - a plain host;
4 - a host converted from prototype.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |inventory\_mode|integer|Host inventory population mode.

Possible values:
-1 - *(default)* disabled;
0 - manual;
1 - automatic.| |ipmi\_authtype|integer|IPMI authentication algorithm.

Possible values:
-1 - *(default)* default;
0 - none;
1 - MD2;
2 - MD5
4 - straight;
5 - OEM;
6 - RMCP+.| |ipmi\_password|string|IPMI password.| |ipmi\_privilege|integer|IPMI privilege level.

Possible values:
1 - callback;
2 - *(default)* user;
3 - operator;
4 - admin;
5 - OEM.| |ipmi\_username|string|IPMI username.| |maintenance\_from|timestamp|Starting time of the effective maintenance.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |maintenance\_status|integer|Effective maintenance status.

Possible values:
0 - *(default)* no maintenance;
1 - maintenance in effect.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |maintenance\_type|integer|Effective maintenance type.

Possible values:
0 - *(default)* maintenance with data collection;
1 - maintenance without data collection.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |maintenanceid|ID|ID of the maintenance that is currently in effect on the host.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |name|string|Visible name of the host.

Default: `host` property value.| |monitored_by|integer|Source that is used to monitor the host.

Possible values:
0 - *(default)* Zabbix server;
1 - Proxy;
2 - Proxy group.| |proxyid|ID|ID of the proxy that is used to monitor the host.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `monitored_by` is set to "Proxy"| |proxy_groupid|ID|ID of the proxy group that is used to monitor the host.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* if `monitored_by` is set to "Proxy group"| |status|integer|Status and function of the host.

Possible values:
0 - *(default)* enabled;
1 - disabled.| |tls\_connect|integer|Connections to host.

Possible values:
1 - *(default)* No encryption;
2 - PSK;
4 - certificate.| |tls\_accept|integer|Connections from host.

Possible bitmap values:
1 - *(default)* No encryption;
2 - PSK;
4 - certificate.

This is a bitmask field; any sum of possible bitmap values is acceptable (for example, 6 for PSK and certificate).| |tls\_issuer|string|Certificate issuer.| |tls\_subject|string|Certificate subject.| |tls\_psk\_identity|string|PSK identity; must be paired with only one PSK (across [autoregistration](/manual/api/reference/autoregistration/object), [hosts](/manual/api/reference/host/object), and [proxies](/manual/api/reference/proxy/object)).

Do not include sensitive information in the PSK identity, as it is sent unencrypted over the network to inform the receiver which PSK to use.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *write-only*
- *required* if `tls_connect` is set to "PSK", or `tls_accept` contains the "PSK" bit| |tls\_psk|string|Pre-shared key (PSK); must be at least 32 hex digits.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *write-only*
- *required* if `tls_connect` is set to "PSK", or `tls_accept` contains the "PSK" bit| |active_available|integer|Host active interface availability status.

Possible values:
0 - interface status is unknown;
1 - interface is available;
2 - interface is not available.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |assigned_proxyid|ID|ID of the proxy assigned by Zabbix server, if the host is monitored by a proxy group.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| [comment]: # ({/7d75bf76-2f6c5c76}) [comment]: # ({53fce8b7-859da78d}) ### 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|Property|[Type](/manual/api/reference_commentary#data-types)|Description|Maximum length| |-|--|-|-----|-----| |4|alias|string|Alias.|128 characters| |11|asset\_tag|string|Asset tag.|64 characters| |28|chassis|string|Chassis.|64 characters| |23|contact|string|Contact person.|65535 characters for SQL databases| |32|contract\_number|string|Contract number.|64 characters| |47|date\_hw\_decomm|string|HW decommissioning date.|64 characters| |46|date\_hw\_expiry|string|HW maintenance expiry date.|64 characters| |45|date\_hw\_install|string|HW installation date.|64 characters| |44|date\_hw\_purchase|string|HW purchase date.|64 characters| |34|deployment\_status|string|Deployment status.|64 characters| |14|hardware|string|Hardware.|255 characters| |15|hardware\_full|string|Detailed hardware.|65535 characters for SQL databases| |39|host\_netmask|string|Host subnet mask.|39 characters| |38|host\_networks|string|Host networks.|65535 characters for SQL databases| |40|host\_router|string|Host router.|39 characters| |30|hw\_arch|string|HW architecture.|32 characters| |33|installer\_name|string|Installer name.|64 characters| |24|location|string|Location.|65535 characters for SQL databases| |25|location\_lat|string|Location latitude.|16 characters| |26|location\_lon|string|Location longitude.|16 characters| |12|macaddress\_a|string|MAC address A.|64 characters| |13|macaddress\_b|string|MAC address B.|64 characters| |29|model|string|Model.|64 characters| |3|name|string|Name.|128 characters| |27|notes|string|Notes.|65535 characters for SQL databases| |41|oob\_ip|string|OOB IP address.|39 characters| |42|oob\_netmask|string|OOB host subnet mask.|39 characters| |43|oob\_router|string|OOB router.|39 characters| |5|os|string|OS name.|128 characters| |6|os\_full|string|Detailed OS name.|255 characters| |7|os\_short|string|Short OS name.|128 characters| |61|poc\_1\_cell|string|Primary POC mobile number.|64 characters| |58|poc\_1\_email|string|Primary email.|128 characters| |57|poc\_1\_name|string|Primary POC name.|128 characters| |63|poc\_1\_notes|string|Primary POC notes.|65535 characters for SQL databases| |59|poc\_1\_phone\_a|string|Primary POC phone A.|64 characters| |60|poc\_1\_phone\_b|string|Primary POC phone B.|64 characters| |62|poc\_1\_screen|string|Primary POC screen name.|64 characters| |68|poc\_2\_cell|string|Secondary POC mobile number.|64 characters| |65|poc\_2\_email|string|Secondary POC email.|128 characters| |64|poc\_2\_name|string|Secondary POC name.|128 characters| |70|poc\_2\_notes|string|Secondary POC notes.|65535 characters for SQL databases| |66|poc\_2\_phone\_a|string|Secondary POC phone A.|64 characters| |67|poc\_2\_phone\_b|string|Secondary POC phone B.|64 characters| |69|poc\_2\_screen|string|Secondary POC screen name.|64 characters| |8|serialno\_a|string|Serial number A.|64 characters| |9|serialno\_b|string|Serial number B.|64 characters| |48|site\_address\_a|string|Site address A.|128 characters| |49|site\_address\_b|string|Site address B.|128 characters| |50|site\_address\_c|string|Site address C.|128 characters| |51|site\_city|string|Site city.|128 characters| |53|site\_country|string|Site country.|64 characters| |56|site\_notes|string|Site notes.|65535 characters for SQL databases| |55|site\_rack|string|Site rack location.|128 characters| |52|site\_state|string|Site state.|64 characters| |54|site\_zip|string|Site ZIP/postal code.|64 characters| |16|software|string|Software.|255 characters| |18|software\_app\_a|string|Software application A.|64 characters| |19|software\_app\_b|string|Software application B.|64 characters| |20|software\_app\_c|string|Software application C.|64 characters| |21|software\_app\_d|string|Software application D.|64 characters| |22|software\_app\_e|string|Software application E.|64 characters| |17|software\_full|string|Software details.|65535 characters for SQL databases| |10|tag|string|Tag.|64 characters| |1|type|string|Type.|64 characters| |2|type\_full|string|Type details.|64 characters| |35|url\_a|string|URL A.|2048 characters| |36|url\_b|string|URL B.|2048 characters| |37|url\_c|string|URL C.|2048 characters| |31|vendor|string|Vendor.|64 characters| [comment]: # ({/53fce8b7-859da78d}) [comment]: # ({c531ae6d-0ae1807e}) ### Host tag The host tag object has the following properties. |Property|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |tag|string|Host tag name.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*| |value|string|Host tag value.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*.| |automatic|integer|Type of host tag.

Possible values:
0 - *(default)* manual (tag created by user);
1 - automatic (tag created by low-level discovery)

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*| |object|integer|Type of object the tag was inherited from.

Possible values:
0 - template.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*.| |objectid|ID|ID of the object the tag was inherited from.

[Property behavior](/manual/api/reference_commentary#property-behavior):
- *read-only*.| [comment]: # ({/c531ae6d-0ae1807e})