Computers
Refer to the REST API for hardware (v2) to know about the BigFix Inventory computers (hardware) API v2.
Example of API request URL used to transfer computers data to
ServiceNow:
[BFI_URL]/api/sam/v2/computers?token=[FILTERED]&offset=0&limit=50000&order[]=id&criteria={"and":[["is_deleted","=","0"],["computer_hardware.status","=","1"],["os_type","!=","MACOS"],["os_type","!=","AIX"]]}&columns[]=id&columns[]=bigfix_id&columns[]=computer_group_id&columns[]=name&columns[]=dns_name&columns[]=os&columns[]=os_type&columns[]=first_seen&columns[]=last_seen&columns[]=is_deleted&columns[]=deletion_date&columns[]=is_managed_by_vm_manager&columns[]=detailed_hw_smbios.system_serial_number&columns[]=detailed_hw_ip_addresses.permanent_mac_address&columns[]=detailed_hw_ip_addresses.id&columns[]=detailed_hw_ip_addresses.address&columns[]=detailed_hw_storages.total_size&columns[]=detailed_hw_storages.id&columns[]=detailed_hw_memories.total_physical&columns[]=detailed_hw_memories.id&columns[]=detailed_hw_storages.device&columns[]=detailed_hw_network_adapters.type&columns[]=detailed_hw_network_adapters.permanent_address&columns[]=detailed_hw_network_adapters.current_address&columns[]=detailed_hw_network_adapters.model&columns[]=computer_hardware.status&columns[]=computer_hardware.server_serial_number&columns[]=computer_hardware.computer_type&columns[]=computer_hardware.server_type&columns[]=computer_hardware.server_model&columns[]=computer_hardware.server_vendor&columns[]=detailed_hw_ip_addresses.ipv6_address
Note: The actual URL is different as it is the URI encoded and it
follows the ServiceNow formatting. Review logs of API calls with their URLs in
BigFix Inventory’s tema.log.
Example of API JSON response:
{
"total": 25644,
"rows": [
{
"id": 3,
"bigfix_id": 10000000,
"computer_group_id": 0,
"name": "BFI-T-WIN19",
"dns_name": "BFI-t-Win19",
"os": "Win2019 10.0.17763.107 (1809)",
"os_type": "WINDOWS",
"first_seen": "2024-10-31T16:05:05Z",
"last_seen": "2025-01-25T00:10:53Z",
"is_deleted": 0,
"deletion_date": null,
"is_managed_by_vm_manager": 1,
"computer_hardware": {
"status": "1",
"server_serial_number": "XXXXXXXXXXXXXXXX",
"computer_type": 1,
"server_type": null,
"server_model": "PowerEdge M640",
"server_vendor": "Dell Inc."
},
"detailed_hw_smbios": [
{
"system_serial_number": "VMware-XX XX XX XX XX XX XX XX-XX XX XX XX XX XX XX XX"
}
],
"detailed_hw_ip_addresses": [
{
"permanent_mac_address": "00:00:00:00:00:00",
"id": 3,
"address": "10.100.100.100",
"ipv6_address": "0000:0000:0000:0000:0000:0000:00000000"
}
],
"detailed_hw_storages": [
{
"total_size": "102398",
"id": 5,
"device": "\\\\.\\PHYSICALDRIVE0"
},
{
"total_size": "0",
"id": 6,
"device": ""
}
],
"detailed_hw_memories": [
{
"total_physical": "8388084",
"id": 3
}
],
"detailed_hw_network_adapters": [
{
"type": "Ethernet Adapter",
"permanent_address": "00:00:00:00:00:00",
"current_address": "00:00:00:00:00:00",
"model": "Intel(R) 82574L Gigabit Network Connection"
}
API data availability in BigFix Inventory report columns
BigFix Inventory Computers API | BigFix Inventory U |
---|---|
id | Internal Computer ID |
bigfix_id | Data Source Computer ID |
computer_group_id | not available - it will always be equal to 0, which represents the “All computers” group |
name | Computer Name |
dns_name | DNS Name |
os | Operating System |
os_type | (not available) |
first_seen | First Seen |
last_seen | Last Seen |
is_deleted | (not available) |
deletion_date | (not available) |
is_managed_by_vm_manager | (not available) |
computer_hardware.status | Status |
computer_hardware.server_serial_number | Server Serial Number |
computer_hardware.computer_type | Computer Type |
computer_hardware.server_type | Server Type |
computer_hardware.server_model | Server Model |
computer_hardware.server_vendor | Server Vendor |
detailed_hw_smbios.system_serial_number | System Serial Number |
detailed_hw_ip_addresses.permanent_mac_address | (not available) |
detailed_hw_ip_addresses.id | (not available) |
detailed_hw_ip_addresses.address | (not available) |
detailed_hw_ip_addresses.ipv6_address | (not available) |
detailed_hw_storages.total_size | (not available) |
detailed_hw_storages.id | (not available) |
detailed_hw_storages.device | (not available) |
detailed_hw_memories.total_physical | (not available) |
detailed_hw_memories.id | (not available) |
detailed_hw_network_adapters.type | (not available) |
detailed_hw_network_adapters.permanent_address | (not available) |
detailed_hw_network_adapters.current_address | (not available) |
detailed_hw_network_adapters.model | (not available) |
Existing mappings
Computer (cmdb_ci_computer)
CMDB field name | API field name | ETL transforme |
---|---|---|
DNS Domain | dns_name | |
First Discovered | first_seen | |
Is virtual | is_managed_by_vm_manager | |
Manufacturer | server_model, server_vendor | ✓ |
Model ID | server_model, server_vendor | ✓ |
Most recent discovery | last_seen | |
Name | name | ✓ |
Operating System | os | |
RAM | detailed_hw_memories.total_physical | ✓ |
Serial Number | detailed_hw_smbios.system_serial_number |
Serial Number (cmdb_ci_serial_number)
Note: There are 2 types of Serial Numbers synchronized: the BIOS and
System serial number.
CMDB field name | API field name | ETL transforme |
---|---|---|
Serial Number | detailed_hw_smbios.system_serial_number | |
Serial Number Type | (hardcoded to “bios”) | ✓ |
Valid | detailed_hw_smbios.system_serial_number | ✓ |
CMDB field name | API field name | ETL transforme |
---|---|---|
Serial Number | computer_hardware.server_serial_number | |
Serial Number Type | (hardcoded to “system”) | ✓ |
Valid | computer_hardware.server_serial_number | ✓ |
Disk (cmdb_ci_disk)
CMDB field name | API field name | ETL transforme |
---|---|---|
Device ID | detailed_hw_storages.device | ✓ |
Name | detailed_hw_storages.device | ✓ |
Disk space (GB) | detailed_hw_storages.total_size | ✓ |
Size bytes | detailed_hw_storages.total_size | ✓ |
IP Address (cmdb_ci_ip_address)
CMDB field name | API field name | ETL transforme |
---|---|---|
IP Address | detailed_hw_ip_addresses.address | |
Name | detailed_hw_ip_addresses.address | |
Mac Address | detailed_hw_network_adapters.permanent_address | |
Nic | (not available) |
Network Adapter (cmdb_ci_network_adapter)
CMDB field name | API field name | ETL transforme |
---|---|---|
Configuration Item | (not available) | |
Mac Address | detailed_hw_network_adapters.permanent_address | |
Name | detailed_hw_network_adapters.permanent_address |