System data mapping
This page describes how data retrieved from the source service is mapped into records generated by the connector.
For each record type, the following information is reported:
- the property name exposed by the connector;
- the path from which the value is obtained in the source service;
- any additional note regarding transformations, enrichments or special behaviours.
Each record mapping section is titled {Source Object Name} ({_type}), combining the object name used by the source service with the internal record type produced by the connector.
The connector can read the data using either version of the GLPI REST API, so the source path is reported for both of them (API V1 and API V2). A - means that the property is not read with that version.
Common properties
The following properties are present in all the record types, unless otherwise stated in the notes.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| id | id | id | |
| name | name | name | The designation field is used for the component records (processor, graphic card, etc.) |
| entities | entities_id | entity/name |
Notes
- With API V1 the requests use
expand_dropdowns=true, so the fields that refer to other GLPI objects (*_id) contain the name of the object. The value0(no object selected) is read as empty. - The
Softwarerecords have noidwith API V1 and are identified by name and version. - The calculated records (
ipand the relation records) do not have these properties, except where reported in their sections.
Asset properties
The following properties are read for the computer, monitor, printer and phone records.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| state | states_id | status/name | |
| location | locations_id | location/name | |
| technician_in_charge | users_id_tech | user_tech/name | |
| manufacturer | manufacturers_id | manufacturer/name | |
| group_in_charge | groups_id_tech | group_tech.name | With API V2 it is read through a JSON path |
| model | computermodels_id, monitormodels_id, printermodels_id, phonemodels_id | model/name | The V1 field depends on the record type |
| alternate_username_number | contact_num | contact_num | |
| serial_number | serial | serial | |
| alternate_username | contact | contact | Truncated to the first 200 characters |
| inventory_number | otherserial | otherserial | |
| update_source | autoupdatesystems_id | autoupdatesystem/name | |
| user | users_id | user/name | |
| group | groups_id | group.name | With API V2 it is read through a JSON path |
| uuid | uuid | uuid | |
| comment | comment | comment |
Financial properties
The following properties (Infocom data of the asset) are read for the computer, monitor, printer and phone records. With API V1 they are read from the _infocoms object of the item, with API V2 from the Infocom category of the asset (Assets/{type}/{id}/Infocom). If the asset has no Infocom data, the properties are empty.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| order_date | _infocoms/order_date | date_order | |
| purchase_date | _infocoms/buy_date | date_buy | |
| delivery_date | _infocoms/delivery_date | date_delivery | |
| startup_date | _infocoms/use_date | date_use | |
| last_physical_inventory_date | _infocoms/inventory_date | date_inventory | |
| decommission_date | _infocoms/decommission_date | date_decommission | Formatted to yyyy-MM-dd |
| supplier | _infocoms/suppliers_id | supplier.name | |
| budget | _infocoms/budgets_id | budget.name | |
| order_number | _infocoms/order_number | order_number | |
| immobilization_number | _infocoms/immo_number | immo_number | |
| invoice_number | _infocoms/bill | invoice_number | |
| delivery_form | _infocoms/delivery_number | delivery_number | |
| value | _infocoms/value | value | |
| warranty_extension_value | _infocoms/warranty_value | warranty_value | |
| amortization_type | _infocoms/sink_type | amortization_type | The code 1 is converted to Decreasing, the code 2 to Linear, any other value is ignored |
| amortization_duration | _infocoms/sink_time | amortization_time | |
| amortization_coefficient | _infocoms/sink_coeff | amortization_coeff | |
| business_criticity | _infocoms/businesscriticities_id | business_criticity.name | |
| infocom_comment | _infocoms/comment | comment | |
| warranty_start_date | _infocoms/warranty_date | date_warranty | |
| warranty_duration | _infocoms/warranty_duration | warranty_duration | |
| warranty_information | _infocoms/warranty_info | warranty_info | |
| alert | _infocoms/alert | - | Not available with API V2 |
Computer (computer)
A computer registered in GLPI. In addition to the asset and financial properties, the record carries the references to the related records, the operating system data and, with API V1, the data of the network ports.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| computer_type | computertypes_id | type/name | |
| network | networks_id | network/name | |
| last_boot | last_boot | last_boot | With API V2 formatted to yyyy-MM-dd HH:mm:ss |
| os_name | Item_OperatingSystem operatingsystems_id | OSInstallation operatingsystem.name | Operating system data is read from an additional call, using the first element of the response |
| os_version | Item_OperatingSystem operatingsystemversions_id | OSInstallation version.name | See os_name |
| os_architecture | Item_OperatingSystem operatingsystemarchitectures_id | OSInstallation architecture.name | See os_name |
| os_service_pack | Item_OperatingSystem operatingsystemservicepacks_id | OSInstallation servicepack.name | See os_name |
| os_kernel | Item_OperatingSystem operatingsystemkernelversions_id | OSInstallation kernel_version.name | See os_name |
| os_edition | Item_OperatingSystem operatingsystemeditions_id | OSInstallation edition.name | See os_name |
| os_product_id | Item_OperatingSystem licenseid | OSInstallation licenseid | See os_name |
| os_serial_number | Item_OperatingSystem license_number | OSInstallation license_number | See os_name |
| os_company | Item_OperatingSystem company | OSInstallation company | See os_name |
| os_owner | Item_OperatingSystem owner | OSInstallation owner | See os_name |
| os_installation_date | Item_OperatingSystem install_date | OSInstallation date_install | See os_name. With API V2 formatted to yyyy-MM-dd |
| os_host_id | Item_OperatingSystem hostid | OSInstallation hostid | See os_name |
| processors | _devices/Item_DeviceProcessor link to DeviceProcessor | Component/Processor id | Record Id of the related processor records |
| graphic_cards | _devices/Item_DeviceGraphicCard link to DeviceGraphicCard | Component/GraphicCard id | Record Id of the related graphiccard records |
| firmwares | _devices/Item_DeviceFirmware link to DeviceFirmware | Component/Firmware id | Record Id of the related firmware records |
| memories | _devices/Item_DeviceMemory link to DeviceMemory | Component/Memory id | Record Id of the related memory records |
| batteries | _devices/Item_DeviceBattery link to DeviceBattery | Component/Battery id | Record Id of the related battery records |
| hard_drives | _devices/Item_DeviceHardDrive link to DeviceHardDrive | Component/HardDrive id | Record Id of the related harddrive records |
| softwares | _softwares (softwares_id, softwareversions_id) | SoftwareInstallation | Record Id of the related software records |
| monitors | _connections.Monitor.id | PeripheralConnection (Monitor) | Record Id of the related monitor records |
| printers | _connections.Printer.id | PeripheralConnection (Printer) | Record Id of the related printer records |
| phones | - | PeripheralConnection (Phone) | Record Id of the related phone records |
| agents | Computer/{id}/Agent id | items_id of the Agent records | Record Id of the related agent records |
Notes
- The relations
hard_drivesandphonesare read, but the corresponding relations are not created by the bus descriptor.
Monitor (monitor)
A monitor registered in GLPI. With API V1 the record is read through the getMultipleItems call.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| monitor_type | monitortypes_id | type/name | |
| size | size | size | |
| microphone | have_micro | has_microphone | |
| speaker | have_speaker | has_speaker | |
| sub-d | have_subd | has_subd | |
| bnc | have_bnc | has_bnc | |
| dvi | have_dvi | has_dvi | |
| pivot | have_pivot | has_pivot | |
| hdmi | have_hdmi | has_hdmi | |
| displayport | have_displayport | has_displayport |
Printer (printer)
A printer registered in GLPI. With API V1 the record is read through the getMultipleItems call.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| printer_type | printertypes_id | type/name | |
| network | networks_id | network/name | |
| sysdescr | sysdescr | sysdescr | |
| snmp_credentials | snmpcredentials_id | snmp_credential/name | |
| initial_page_counter | init_pages_counter | - | Not read with API V2 |
| current_counter_of_pages | last_pages_counter | - | Not read with API V2 |
| memory_size | memory_size | - | Not read with API V2 |
| serial | have_serial | has_serial | |
| parallel | have_parallel | has_parallel | |
| usb | have_usb | has_usb | |
| wifi | have_wifi | has_wifi | |
| ethernet | have_ethernet | has_ethernet |
Phone (phone)
A phone registered in GLPI. With API V1 the record is read through the getMultipleItems call.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| phone_type | phonetypes_id | type/name | |
| brand | brand | brand | |
| number_of_lines | number_line | number_line | |
| phone_power_supply_type | phonepowersupplies_id | power_supply/name | |
| headset | have_headset | have_headset | |
| speaker | have_hp | have_hp |
Software (software)
A software installed on at least one computer. One record is created for each software and version found in the installations of the computers.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| id | - | Software id | |
| name | _softwares softwares_id | Software name | |
| version | _softwares softwareversions_id | SoftwareInstallation softwareversion.name | |
| entities | Software entities_id | Software entity/name | |
| comment | Software comment | Software comment | |
| location | Software locations_id | Software location/name | |
| technician_in_charge | Software users_id_tech | Software user_tech/name | |
| publisher | Software manufacturers_id | Software manufacturer/name | |
| group_in_charge | Software groups_id_tech | Software group_tech.name | |
| user | Software users_id | Software user/name | |
| group | Software groups_id | Software group.name | |
| is_update | Software is_update | Software is_update | |
| is_valid | Software is_valid | Software is_valid | |
| software_category | Software softwarecategories_id | Software category/name |
Notes
- The descriptive properties are read from the list of the GLPI software (
Software). With API V1 the list is indexed by name: if several GLPI software share the same name, the data of only one of them is used. - Software that are not found in the list (for example because they have been deleted) are ignored.
Processor (processor)
A processor model registered among the GLPI components.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| comment | comment | comment | |
| manufacturer | manufacturers_id | manufacturer/name | |
| frequency | frequence | frequency | |
| default_frequency | frequency_default | frequency_default | |
| core_number | nbcores_default | nbcores_default | |
| thread_number | nbthreads_default | nbthreads_default | |
| model | deviceprocessormodels_id | model/name |
Graphic card (graphiccard)
A graphic card model registered among the GLPI components.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| comment | comment | comment | |
| manufacturer | manufacturers_id | manufacturer/name | |
| chipset | chipset | chipset | |
| memory | memory_default | memory_default | |
| interface | interfacetypes_id | interface/name | |
| model | devicegraphiccardmodels_id | model/name |
Firmware (firmware)
A firmware model registered among the GLPI components.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| comment | comment | comment | |
| manufacturer | manufacturers_id | manufacturer/name | |
| firmware_type | devicefirmwaretypes_id | type/name | |
| release_date | date | date | With API V2 formatted to yyyy-MM-dd |
| version | version | version | |
| model | devicefirmwaremodels_id | model/name |
Memory (memory)
A memory module model registered among the GLPI components.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| comment | comment | comment | |
| manufacturer | manufacturers_id | manufacturer/name | |
| default_size | size_default | size_default | Converted from MB to GB |
| frequency | frequence | frequency | The server returns a value such as 1333 MHz: the unit is removed and the value divided by 1000 |
| memory_type | devicememorytypes_id | type/name | |
| model | devicememorymodels_id | model/name |
Hard drive (harddrive)
A hard drive model registered among the GLPI components.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| comment | comment | comment | |
| manufacturer | manufacturers_id | manufacturer/name | |
| default_capacity | capacity_default | capacity_default | Converted from MB to GB |
| rotations_per_minute | rpm | rpm | |
| cache | cache | cache | |
| model | deviceharddrivemodels_id | model/name | |
| interface | interfacetypes_id | interface/name |
Battery (battery)
A battery model registered among the GLPI components.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| comment | comment | comment | |
| manufacturer | manufacturers_id | manufacturer/name | |
| battery_type | devicebatterytypes_id | type/name | |
| capacity | capacity | capacity | Divided by 1000 and rounded to one decimal (Wh) |
| voltage | voltage | voltage | Divided by 1000 and rounded to one decimal (V) |
| creation_date | date_creation | date_creation | With API V2 formatted to yyyy-MM-dd HH:mm:ss |
Agent (agent)
An inventory agent registered in GLPI.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| agent_type | agenttypes_id | type/name | |
| locked | locked | locked | |
| device_id | deviceid | deviceid | |
| port | port | port | |
| public_address | remote_addr | remote_address | |
| item_type | itemtype | itemtype | |
| version | version | version | |
| tag | tag | tag | |
| useragent | useragent | useragent | |
| last_contact | last_contact | last_contact | With API V2 formatted to yyyy-MM-dd HH:mm:ss |
| network_discovery_threads | threads_networkdiscovery | threads_network_discovery | |
| network_discovery_timeout | timeout_networkdiscovery | timeout_network_discovery | |
| network_inventory_threads | threads_networkinventory | threads_network_inventory | |
| network_inventory_timeout | timeout_networkinventory | timeout_network_inventory | |
| wake_on_lan | use_module_wake_on_lan | use_module_wake_on_lan | |
| computer_inventory | use_module_computer_inventory | use_module_computer_inventory | |
| esx_remote_inventory | use_module_esx_remote_inventory | use_module_esx_remote_inventory | |
| network_inventory | use_module_network_inventory | use_module_network_inventory | |
| network_discovery | use_module_network_discovery | use_module_network_discovery | |
| package_deployment | use_module_package_deployment | use_module_package_deployment | |
| collect_data | use_module_collect_data | use_module_collect_data | |
| remote_inventory | use_module_remote_inventory | use_module_remote_inventory |
Notes
- The
agentrecords have nocommentproperty.
Disk (disk)
A volume of a computer. The records are read from the data of each computer: with API V1 from the _disks object, with API V2 from the Volume category of the asset (Assets/Computer/{id}/Volume).
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| automatic_inventory | is_dynamic | is_dynamic | |
| partition | device | device | |
| mount_point | mountpoint | mount_point | |
| file_system | filesystems_id | filesystem/name | |
| global_size | totalsize | total_size | Converted from MB to GB |
| free_size | freesize | free_size | Converted from MB to GB |
| encryption_status | encryption_status | encryption_status | The code 0 is converted to Not encrypted, 1 to Encrypted, 2 to Partially encrypted; any other value is ignored |
| encryption_tool | encryption_tool | encryption_tool | |
| encryption_algorithm | encryption_algorithm | encryption_algorithm | |
| encryption_type | encryption_type | encryption_type | |
| device | Record Id of the related computer |
Notes
- With API V1 the value
0ofencryption_statusis read as empty, so theNot encryptedstatus is only produced with API V2.
Network port (networkport)
A network port of a computer or of a printer. The records are available only with API V1, read from the _networkports object of the item.
| Property name | Source path API V1 | Source path API V2 | Notes |
|---|---|---|---|
| id | id | - | |
| name | name | - | |
| entities | entities_id | - | |
| port_type | key of the group in _networkports | - | Type of the port, for example NetworkPortEthernet |
| port_number | logical_number | - | |
| mac | mac | - | |
| ips | NetworkName.IPAddress.name | - | Distinct IP addresses of the port, separated by space. They are used to generate the ip records |
| device | - | Record Id of the related computer or printer |
IP address (ip)
Calculated record: one record is generated for each IP address listed in the ips property of a networkport record. Available only with API V1.
| Property name | Source path | Notes |
|---|---|---|
| ip | networkport.ips | One of the IP addresses of the network port |
| entities | networkport.entities | |
| networkPortRecordId | Record Id of the related networkport | |
| deviceRecordId | Record Id of the computer or printer of the port |
Relations between computers and other records
Calculated records: for each Record Id listed in the properties of a computer record that refers to other records, one relation record is generated. They are used to populate the N:N relations in CMDBuild.
| Record type | Computer property | Related record type | Notes |
|---|---|---|---|
computercpurelation | processors | processor | Related record in processorRecordId |
computergpurelation | graphic_cards | graphiccard | Related record in graphicCardRecordId |
computerfirmwarerelation | firmwares | firmware | Related record in firmwareRecordId |
computermemoryrelation | memories | memory | Related record in memoryRecordId |
computerbatteryrelation | batteries | battery | Related record in batteryRecordId |
computersoftwarerelation | softwares | software | Related record in softwareRecordId |
computermonitorrelation | monitors | monitor | Related record in monitorRecordId |
computerprinterrelation | printers | printer | Related record in printerRecordId |
computeragentrelation | agents | agent | Related record in agentRecordId |
The computer is always referenced by the computerRecordId property.
Notes
- No relation records are generated for the properties
hard_drivesandphones.