NetBox Labs Attribute Reference
This reference lists the attributes that Device Security collects from NetBox Labs,
their names as stored in Device Security, and the Device Security fields they map to.
Device Security integrates with NetBox to enrich the device inventory with IP
address management and data center infrastructure data. The attributes in this
reference cover device records, network interface data, and subnet information
from the NetBox platform.
The third-party attribute name in Device Security refers to the attribute name
as it appears in the Assets Inventory table and in Query Engine. This follows the format
of third-party-name.attribute-name.
When viewing the attribute name in the Assets Inventory table column selector or on a
Device Details page, where the third-party name can be found as a header for the
attributes section, then the third-party name is removed from the attribute name.
For example, micrsoft_defender_xdr.macAddress would appear in the
Query Builder and in the Assets Inventory table, but under , the attribute would appear as macAddress.
Ipam Devices Addresses Attributes
Device Security collects ipam devices addresses attributes from NetBox Labs. The following table lists each NetBox Labs attribute, its name as stored in Device Security, and the Device Security field it maps to (if applicable).
NetBox Labs Attribute | Device Security Attribute Name | Device Security Common Attribute* | Description |
role.slug | netbox.role.slug | device_type | Slug |
name | netbox.name | hostname | Name of the device |
mgmt_if_mac_address | — | id; MAC | Mgmt if mac address |
mgmt_if_ip_address | — | IP Address | Mgmt if ip address |
last_updated | netbox.last_updated | Last Activity | Last updated |
site.name | netbox.site.name | Location | Name of the device |
device_type.model | netbox.device_type.model | Model | Model of the device |
site.slug | netbox.site.slug | Site | Slug |
created | netbox.created | — | Created |
device_type.slug | netbox.device_type.slug | — | Slug |
|
interface_count | netbox.interface_count | — | Number of interfaces |
primary_ip4.address | netbox.primary_ip4.address | — | Address |
primary_ip4.dns_name | netbox.primary_ip4.dns_name | — | Dns name |
primary_ip4.family.label | netbox.primary_ip4.family.label | — | Label |
primary_ip4.nat_inside | netbox.primary_ip4.nat_inside | — | Nat inside |
primary_ip4.nat_outside | netbox.primary_ip4.nat_outside | — | Nat outside |
primary_ip4.status | netbox.primary_ip4.status | — | Status of the device |
role.name | netbox.role.name | — | Name of the device |
site.status | netbox.site.status | — | Status of the device |
status | netbox.status | — | Status of the device |
tenant.name | netbox.tenant.name | — | Name of the device |
tenant.slug | netbox.tenant.slug | — | Slug |
Ipam Multi Interfaces Attributes
Device Security collects ipam multi interfaces attributes from NetBox Labs. The following table lists each NetBox Labs attribute, its name as stored in Device Security, and the Device Security field it maps to (if applicable).
NetBox Labs Attribute | Device Security Attribute Name | Device Security Common Attribute* | Description |
mgmt_if_mac_address | — | id; MAC | Mgmt if mac address |
mgmt_if_ip_address | — | IP Address | Mgmt if ip address |
interfaces | — | third_party_learned_network_interfaces | Interfaces |
Ipam Subnet Prefixes Attributes
Device Security collects ipam subnet prefixes attributes from NetBox Labs. The following table lists each NetBox Labs attribute, its name as stored in Device Security, and the Device Security field it maps to (if applicable).
NetBox Labs Attribute | Device Security Attribute Name | Device Security Common Attribute* | Description |
description | netbox.description | Description | Description |
prefix | netbox.prefix | id; Type; prefix | Prefix |
scope.slug | netbox.scope.slug | Site | Slug |
vlan.vid | netbox.vlan.vid | VLAN ID | Vid |
created | netbox.created | — | Created |
display | netbox.display | — | Display |
family.label | netbox.family.label | — | Label |
|
is_pool | netbox.is_pool | — | Is pool |
last_updated | netbox.last_updated | — | Last updated |
mark_utilized | netbox.mark_utilized | — | Mark utilized |
role.slug | netbox.role.slug | — | Slug |
scope_id | netbox.scope_id | — | Scope ID |
scope_type | netbox.scope_type | — | Scope type |
status.label | netbox.status.label | — | Label |
|
tenant.slug | netbox.tenant.slug | — | Slug |
vlan.display | netbox.vlan.display | — | Display |
|
vlan.name | netbox.vlan.name | — | Name of the device |
|
* Only some attributes map to a Device Security Common Attribute.
