> Icon map object

The following objects are directly related to the iconmap API.

Icon map

The icon map object has the following properties.

PropertyTypeDescription
iconmapidstringID of the icon map.

Property behavior:
- read-only
- required for update operations
default_iconidstringID of the default icon.

Property behavior:
- required for create operations
namestringName of the icon map.

Property behavior:
- required for create operations

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
iconidstringID of the icon used by the icon mapping.

Property behavior:
- required
expressionstringExpression to match the inventory field against.

Property behavior:
- required
inventory_linkintegerID of the host inventory field.

Refer to the host inventory object for a list of supported inventory fields.

Property behavior:
- required
sortorderintegerPosition of the icon mapping in the icon map.

Property behavior:
- read-only