Device Security
NetBox Attribute Reference
Table of Contents
Expand All
|
Collapse All
Device Security Docs
NetBox Attribute Reference
This reference lists the attributes that Device Security collects from NetBox,
their names as stored in Device Security, and the Device Security device 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 Device DetailsAttributesIntegration Specific AttributesMicrosoft Defender, the attribute would appear as macAddress.
Device Attributes
Device Security collects device attributes from the NetBox API. The following table lists each NetBox attribute, its name as stored in Device Security, and the Device Security device field it maps to (if applicable).
|
NetBox Attribute
|
Device Security Attribute Name
|
Device Security Common Attribute*
|
Description
|
|---|---|---|---|
|
created
|
netbox.created
|
—
|
Created Time
|
|
device_type.model
|
netbox.device_type.model
|
Model
|
Device type model
|
|
device_type.slug
|
netbox.device_type.slug
|
—
|
Device type slug
|
|
id
|
netbox.id
|
—
|
Unique identifier
|
|
interface_count
|
netbox.interface_count
|
—
|
Interface count
|
|
last_updated
|
netbox.last_updated
|
Last Third-Party Activity
|
Last updated time
|
|
mgmt_if_ip_address
|
—
|
ipv4_address
|
Management interface IP address attribute collected from NetBox
|
|
mgmt_if_mac_address
|
—
|
MAC; id
|
Management interface MAC address attribute collected from NetBox
|
|
name
|
netbox.name
|
Hostname
|
Device name
|
|
primary_ip4.address
|
netbox.primary_ip4.address
|
—
|
Primary IPv4 address
|
|
primary_ip4.dns_name
|
netbox.primary_ip4.dns_name
|
—
|
DNS name
|
|
primary_ip4.family.label
|
netbox.primary_ip4.family.label
|
—
|
Primary IPv4 family 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
|
—
|
Primary IPv4 status
|
|
role.name
|
netbox.role.name
|
—
|
Device role name
|
|
role.slug
|
netbox.role.slug
|
Device Type
|
Device role slug
|
|
site.name
|
netbox.site.name
|
Location
|
Site name
|
|
site.slug
|
netbox.site.slug
|
Site
|
Site slug
|
|
site.status
|
netbox.site.status
|
—
|
Site status
|
|
status
|
netbox.status
|
—
|
Device status
|
|
tenant.name
|
netbox.tenant.name
|
—
|
Tenant name
|
|
tenant.slug
|
netbox.tenant.slug
|
—
|
Tenant slug
|
Interface Attributes
Device Security collects network interface attributes from the NetBox API. The following table lists each NetBox interface attribute, its name as stored in Device Security, and the Device Security field it maps to (if applicable).
|
NetBox Attribute
|
Device Security Attribute Name
|
Device Security Common Attribute*
|
Description
|
|---|---|---|---|
|
interfaces
|
—
|
third_party_learned_network_interfaces
|
Interfaces attribute collected from NetBox
|
|
mgmt_if_ip_address
|
—
|
ipv4_address
|
Management interface IP address attribute collected from NetBox
|
|
mgmt_if_mac_address
|
—
|
MAC; id
|
Management interface MAC address attribute collected from NetBox
|
Subnet Attributes
Device Security collects subnet attributes from the NetBox API. The following table lists each NetBox subnet attribute, its name as stored in Device Security, and the Device Security subnet field it maps to (if applicable).
|
NetBox Attribute
|
Device Security Attribute Name
|
Device Security Common Attribute*
|
Description
|
|---|---|---|---|
|
created
|
netbox.created
|
—
|
Created Time
|
|
description
|
netbox.description
|
Description
|
Free-text description of the subnet in NetBox
|
|
display
|
netbox.display
|
—
|
Display name
|
|
family.label
|
netbox.family.label
|
—
|
IP family label
|
|
id
|
netbox.id
|
—
|
Unique identifier
|
|
is_pool
|
netbox.is_pool
|
—
|
Is pool flag
|
|
last_updated
|
netbox.last_updated
|
—
|
Last updated time
|
|
mark_utilized
|
netbox.mark_utilized
|
—
|
Mark as utilized flag
|
|
prefix
|
netbox.prefix
|
id; prefix; type
|
Network prefix
|
|
role.slug
|
netbox.role.slug
|
—
|
Device role slug
|
|
scope.slug
|
netbox.scope.slug
|
Site
|
Scope slug
|
|
scope_id
|
netbox.scope_id
|
—
|
Scope ID
|
|
scope_type
|
netbox.scope_type
|
—
|
Scope type
|
|
status.label
|
netbox.status.label
|
—
|
Status label
|
|
tags
|
netbox.tags
|
—
|
Tags assigned to the subnet in NetBox
|
|
tenant.slug
|
netbox.tenant.slug
|
—
|
Tenant slug
|
|
vlan.display
|
netbox.vlan.display
|
—
|
VLAN display name
|
|
vlan.id
|
netbox.vlan.id
|
—
|
VLAN identifier
|
|
vlan.name
|
netbox.vlan.name
|
—
|
VLAN name
|
|
vlan.vid
|
netbox.vlan.vid
|
VLAN ID
|
VLAN ID
|
|
vrf
|
netbox.vrf
|
—
|
Virtual routing and forwarding (VRF) instance associated with the subnet in NetBox
|
* Only some attributes map to a Device Security Common Attribute.