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 first part of the Source path is the table of the OCS database that contains the information, while the second is the column.
Common properties
| Property name | Source path | Notes |
|---|---|---|
| ocs_id | <table>.ID | <table> is the table of the record type |
| hostname | hardware.NAME | Name of the hardware the record belongs to. For hardware records it is the name of the hardware itself |
| hardware_record_id | Record Id of the related hardware, found by matching hostname. Not present in hardware records |
Notes
- All the records, except
hardware, are extracted only if they are linked to a hardware of the OCS database.
hardware (hardware)
Device discovered by an OCS agent. It is the central record of the OCS inventory: all the other records are related to it.
| Property name | Source path | Notes |
|---|---|---|
| tags | accountinfo.TAG | |
| archived | hardware.ARCHIVE | |
| work_group | hardware.WORKGROUP | |
| user_domain | hardware.USERDOMAIN | |
| os_name | hardware.OSNAME | |
| os_version | hardware.OSVERSION | |
| comments | hardware.OSCOMMENTS | |
| cpu | hardware.PROCESSORT | |
| cpu_speed | hardware.PROCESSORS | Divided by 1024 and rounded to two decimals (MHz to GHz) |
| total_cpu | hardware.PROCESSORN | |
| ram | hardware.MEMORY | Divided by 1024 and rounded to two decimals (MB to GB) |
| hd_size | storages.DISKSIZE | Sum of the size of all the storages of the hardware (0 if there are none). Divided by 1024 and rounded to two decimals (MB to GB) |
| swap | hardware.SWAP | Divided by 1024 and rounded to two decimals (MB to GB) |
| ip_address | hardware.IPADDR | |
| dns | hardware.DNS | |
| company | hardware.WINCOMPANY | |
| owner | hardware.WINOWNER | |
| prod_id | hardware.WINPRODID | |
| prod_key | hardware.WINPRODKEY | |
| serial_number | sim.SERIALNUMBER, bios.SSN | First not null value between sim.SERIALNUMBER and bios.SSN |
| brand | bios.SMANUFACTURER | |
| model | bios.SMODEL | |
| last_date | hardware.LASTDATE | Formatted as YYYY-MM-DD HH:MM:SS |
| type | bios.TYPE | |
| user_agent | hardware.USERAGENT | |
| architecture | hardware.ARCH | |
| description | hardware.DESCRIPTION | |
| user_id | hardware.USERID | |
| default_gateway | hardware.DEFAULTGATEWAY | |
| os_type | hardware.USERAGENT | Case-insensitive check on the value: linux if it contains unix, windows if it contains windows, macos if it contains mac, android if it contains android, null otherwise |
Notes
- Only the hardware that has a record in both the
biosandaccountinfotables is extracted.
networks (net_interface)
Network interface of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| description | networks.DESCRIPTION | |
| type | networks.TYPE | |
| mac_address | networks.MACADDR | |
| ip_address | networks.IPADDRESS | |
| mask | networks.IPMASK | |
| gateway | networks.IPGATEWAY | |
| subnet | networks.IPSUBNET | |
| dhcp | networks.IPDHCP | |
| device | networks.VIRTUALDEV | Converted to a number (VIRTUALDEV + 0) |
| net_status | networks.STATUS | |
| ip | ip_address followed by / and the CIDR prefix obtained from mask. The prefix is omitted if mask is empty or if it is 32 and ip_address is an IPv4 address |
software (software)
Software installed on a hardware.
| Property name | Source path | Notes |
|---|---|---|
| name | software_name.NAME | |
| version | software_version.VERSION | |
| folder | software.FOLDER | |
| comments | software.COMMENTS | |
| file_size | software.FILESIZE | Converted from bytes to GB (divided by 2^30, two decimals) |
| source | software.SOURCE | |
| publisher | software_publisher.PUBLISHER | |
| guid | software.GUID |
Notes
- Only the software that has a name, a version and a publisher record in the OCS database is extracted.
drives (disk)
Logical drive (volume) of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| letter | drives.LETTER | |
| type | drives.TYPE | |
| file_system | drives.FILESYSTEM | |
| total_space | drives.TOTAL | Divided by 1024 and rounded to two decimals (MB to GB) |
| free_space | drives.FREE | Divided by 1024 and rounded to two decimals (MB to GB) |
| num_file | drives.NUMFILES | |
| volume_name | drives.VOLUMN | |
| create_date | drives.CREATEDATE | Formatted as YYYY-MM-DD |
storages (storage)
Physical storage device of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| name | storages.NAME | |
| model | storages.MODEL | |
| manufacturer | storages.MANUFACTURER | |
| description | storages.DESCRIPTION | |
| type | storages.TYPE | |
| disk_size | storages.DISKSIZE | Divided by 1024 and rounded to two decimals (MB to GB) |
| serial_number | storages.SERIALNUMBER | |
| firmware | storages.FIRMWARE |
ports (port)
Port of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| name | ports.NAME | |
| type | ports.TYPE | |
| caption | ports.CAPTION | |
| description | ports.DESCRIPTION |
sim (sim)
SIM card of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| serial_number | sim.SERIALNUMBER | |
| operator | sim.OPERATOR | |
| operator_name | sim.OPNAME | |
| country | sim.COUNTRY | |
| imei | sim.DEVICEID | |
| phone_number | sim.PHONENUMBER |
videos (video_card)
Video card of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| name | videos.NAME | |
| video_chipset | videos.CHIPSET | |
| video_memory | videos.MEMORY | Rounded to two decimals |
| video_resolution | videos.RESOLUTION |
sounds (sound_card)
Sound card of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| name | sounds.NAME | |
| manufacturer | sounds.MANUFACTURER | |
| description | sounds.DESCRIPTION |
virtualmachines (virtual_machine)
Virtual machine reported by OCS for a hardware.
| Property name | Source path | Notes |
|---|---|---|
| name | virtualmachines.NAME | |
| status | virtualmachines.STATUS | |
| subsystem | virtualmachines.SUBSYSTEM | |
| vm_type | virtualmachines.VMTYPE | |
| uuid | virtualmachines.UUID | |
| vm_cpu | virtualmachines.VCPU | |
| vm_memory | virtualmachines.MEMORY | Rounded to two decimals |
inputs (input_device)
Input device of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| type | inputs.TYPE | |
| manufacturer | inputs.MANUFACTURER | |
| caption | inputs.CAPTION | |
| description | inputs.DESCRIPTION | |
| interface | inputs.INTERFACE | |
| point_type | inputs.POINTTYPE |
printers (printer)
Printer configured on a hardware.
| Property name | Source path | Notes |
|---|---|---|
| name | printers.NAME | |
| driver | printers.DRIVER | |
| description | printers.DESCRIPTION | |
| server_name | printers.SERVERNAME | |
| shared | printers.SHARED | |
| share_name | printers.SHARENAME | |
| resolution | printers.RESOLUTION | |
| comment | printers.COMMENT | |
| network | printers.NETWORK | |
| port | printers.PORT |
monitors (monitor)
Monitor connected to a hardware.
| Property name | Source path | Notes |
|---|---|---|
| caption | monitors.CAPTION | |
| description | monitors.DESCRIPTION | |
| manufacturer | monitors.MANUFACTURER | |
| type | monitors.TYPE | |
| serial_number | monitors.SERIAL |
local_groups (local_group)
Local group of the operating system of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| id_group | local_groups.ID_GROUP | |
| name | local_groups.NAME | |
| member | local_groups.MEMBER |
local_users (local_user)
Local user of the operating system of a hardware.
| Property name | Source path | Notes |
|---|---|---|
| group_id | local_users.GID | |
| name | local_users.NAME | |
| home | local_users.HOME | |
| shell | local_users.SHELL | |
| login | local_users.LOGIN | |
| group_record_id | Record Id of the related local_group, found by matching group_id with the id_group of the group |