> Host object

The following objects are directly related to the host API.

Host

The host object has the following properties.

PropertyTypeDescription
hostidstring(readonly) ID of the host.
host
(required)
stringTechnical name of the host.
descriptiontextDescription of the host.
flagsinteger(readonly) Origin of the host.

Possible values:
0 - a plain host;
4 - a discovered host.
inventory_modeintegerHost inventory population mode.

Possible values are:
-1 - (default) disabled;
0 - manual;
1 - automatic.
ipmi_authtypeintegerIPMI authentication algorithm.

Possible values are:
-1 - (default) default;
0 - none;
1 - MD2;
2 - MD5
4 - straight;
5 - OEM;
6 - RMCP+.
ipmi_passwordstringIPMI password.
ipmi_privilegeintegerIPMI privilege level.

Possible values are:
1 - callback;
2 - (default) user;
3 - operator;
4 - admin;
5 - OEM.
ipmi_usernamestringIPMI username.
maintenance_fromtimestamp(readonly) Starting time of the effective maintenance.
maintenance_statusinteger(readonly) Effective maintenance status.

Possible values are:
0 - (default) no maintenance;
1 - maintenance in effect.
maintenance_typeinteger(readonly) Effective maintenance type.

Possible values are:
0 - (default) maintenance with data collection;
1 - maintenance without data collection.
maintenanceidstring(readonly) ID of the maintenance that is currently in effect on the host.
namestringVisible name of the host.

Default: host property value.
proxy_hostidstringID of the proxy that is used to monitor the host.
statusintegerStatus and function of the host.

Possible values are:
0 - (default) monitored host;
1 - unmonitored host.
tls_connectintegerConnections to host.

Possible values are:
1 - (default) No encryption;
2 - PSK;
4 - certificate.
tls_acceptintegerConnections from host.

Possible bitmap values are:
1 - (default) No encryption;
2 - PSK;
4 - certificate.
tls_issuerstringCertificate issuer.
tls_subjectstringCertificate subject.
tls_psk_identitystring(write-only) PSK identity. Required if either tls_connect or tls_accept has PSK enabled.
Do not put sensitive information in the PSK identity, it is transmitted unencrypted over the network to inform a receiver which PSK to use.
tls_pskstring(write-only) The preshared key, at least 32 hex digits. Required if either tls_connect or tls_accept has PSK enabled.

Host inventory

The host inventory object has the following properties.

Each property has it’s own unique ID number, which is used to associate host inventory fields with items.

IDPropertyTypeDescription
4aliasstringAlias.
11asset_tagstringAsset tag.
28chassisstringChassis.
23contactstringContact person.
32contract_numberstringContract number.
47date_hw_decommstringHW decommissioning date.
46date_hw_expirystringHW maintenance expiry date.
45date_hw_installstringHW installation date.
44date_hw_purchasestringHW purchase date.
34deployment_statusstringDeployment status.
14hardwarestringHardware.
15hardware_fullstringDetailed hardware.
39host_netmaskstringHost subnet mask.
38host_networksstringHost networks.
40host_routerstringHost router.
30hw_archstringHW architecture.
33installer_namestringInstaller name.
24locationstringLocation.
25location_latstringLocation latitude.
26location_lonstringLocation longitude.
12macaddress_astringMAC address A.
13macaddress_bstringMAC address B.
29modelstringModel.
3namestringName.
27notesstringNotes.
41oob_ipstringOOB IP address.
42oob_netmaskstringOOB host subnet mask.
43oob_routerstringOOB router.
5osstringOS name.
6os_fullstringDetailed OS name.
7os_shortstringShort OS name.
61poc_1_cellstringPrimary POC mobile number.
58poc_1_emailstringPrimary email.
57poc_1_namestringPrimary POC name.
63poc_1_notesstringPrimary POC notes.
59poc_1_phone_astringPrimary POC phone A.
60poc_1_phone_bstringPrimary POC phone B.
62poc_1_screenstringPrimary POC screen name.
68poc_2_cellstringSecondary POC mobile number.
65poc_2_emailstringSecondary POC email.
64poc_2_namestringSecondary POC name.
70poc_2_notesstringSecondary POC notes.
66poc_2_phone_astringSecondary POC phone A.
67poc_2_phone_bstringSecondary POC phone B.
69poc_2_screenstringSecondary POC screen name.
8serialno_astringSerial number A.
9serialno_bstringSerial number B.
48site_address_astringSite address A.
49site_address_bstringSite address B.
50site_address_cstringSite address C.
51site_citystringSite city.
53site_countrystringSite country.
56site_notesstringSite notes.
55site_rackstringSite rack location.
52site_statestringSite state.
54site_zipstringSite ZIP/postal code.
16softwarestringSoftware.
18software_app_astringSoftware application A.
19software_app_bstringSoftware application B.
20software_app_cstringSoftware application C.
21software_app_dstringSoftware application D.
22software_app_estringSoftware application E.
17software_fullstringSoftware details.
10tagstringTag.
1typestringType.
2type_fullstringType details.
35url_astringURL A.
36url_bstringURL B.
37url_cstringURL C.
31vendorstringVendor.

Host tag

The host tag object has the following properties.

PropertyTypeDescription
tag
(required)
stringHost tag name.
valuestringHost tag value.