> Icon map object

The following objects are directly related to the iconmap API.

Icon map

The icon map object has the following properties.

PropertyTypeDescription
iconmapidstring(readonly) ID of the icon map.
default_iconid
(reqiured)
stringID of the default icon.
name
(required)
stringName of the icon map.

Icon mapping

The icon mapping object defines a specific icon to be used for hosts with a certain inventory field value. It has the following properties.

PropertyTypeDescription
iconmappingidstring(readonly) ID of the icon map.
iconid
(required)
stringID of the icon used by the icon mapping.
expression
(required)
stringExpression to match the inventory field against.
inventory_link
(required)
integerID of the host inventory field.

Refer to the host inventory object for a list of supported inventory fields.
iconmapidstring(readonly) ID of the icon map that the icon mapping belongs to.
sortorderinteger(readonly) Position of the icon mapping in the icon map.