BlueCat IPAM Attribute Reference
Focus
Focus
Device Security

BlueCat IPAM Attribute Reference

Table of Contents

BlueCat IPAM Attribute Reference

This reference lists the attributes that Device Security collects from BlueCat IPAM, their names as stored in Device Security, and the Device Security fields they map to.
When Device Security integrates with BlueCat IPAM, it imports IP address management data to enrich the device inventory with network topology information. The attributes in this reference cover IPv4 address records, IPv4 networks, and IPv4 network blocks.
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.

IPv4 Address Attributes

Device Security collects IPv4 address attributes from BlueCat IPAM. Each record describes a managed IPv4 address and its assignment state. The following table lists each BlueCat IPAM attribute, its name as stored in Device Security, and the Device Security field it maps to (if applicable).
BlueCat IPAM Attribute
Device Security Attribute Name
Device Security Common Attribute*
Description
type
ipam_bluecat.type
Object type (e.g., IP4Address, IP4Network)
state
ipam_bluecat.state
Address assignment state (e.g., DHCP_ALLOCATED, STATIC)
id
ipam_bluecat.id
Internal BlueCat object ID
macAddress
ipam_bluecat.macAddress.address
MAC address associated with the IP address
address
ipam_bluecat.address
IPv4 address

IPv4 Network Attributes

Device Security collects IPv4 network attributes from BlueCat IPAM. Each record describes a managed IPv4 subnet and its address usage statistics. The following table lists each BlueCat IPAM attribute, its name as stored in Device Security, and the Device Security field it maps to (if applicable).
BlueCat IPAM Attribute
Device Security Attribute Name
Device Security Common Attribute*
Description
ipam_bluecat.usage.reserved
Number of reserved addresses in the subnet
ipam_bluecat.usage.static
Number of statically assigned addresses in the subnet
ipam_bluecat.usage.dhcpReserved
Number of DHCP-reserved addresses in the subnet
ipam_bluecat.usage.dhcpAllocated
Number of DHCP-allocated addresses in the subnet
ipam_bluecat.usage.dhcpAbandoned
Number of abandoned DHCP addresses in the subnet
ipam_bluecat.usage.total
Total number of addresses in the subnet
ipam_bluecat.usage.unassigned
Number of unassigned addresses in the subnet
type
ipam_bluecat.type
Object type (e.g., IP4Address, IP4Network)
ipam_bluecat.usage.assigned
Number of assigned addresses in the subnet
gateway
ipam_bluecat.gateway
Gateway IP address for the subnet
ipam_bluecat.location.id
Internal ID of the location associated with the subnet
ipam_bluecat.location.name
Name of the location associated with the subnet
subnet_type
ipam_bluecat.subnet_type
Subnet type (e.g., network, block)
name
ipam_bluecat.name
Name assigned to the subnet or block
range
ipam_bluecat.range
CIDR range of the subnet or block
Site
Site or location name associated with the subnet
subnet_type
Type
Subnet type
name
Device Name
Name of the subnet
range
prefix
CIDR prefix of the subnet

IPv4 Block Attributes

Device Security collects IPv4 block attributes from BlueCat IPAM. Each record describes a managed IPv4 address block and its allocation statistics. The following table lists each BlueCat IPAM attribute, its name as stored in Device Security, and the Device Security field it maps to (if applicable).
BlueCat IPAM Attribute
Device Security Attribute Name
Device Security Common Attribute*
Description
ipam_bluecat.usagePercentage.networkAllocation.unassigned
Percentage of network allocations that are unassigned
ipam_bluecat.usagePercentage.networkAllocation.assigned
Percentage of network allocations that are assigned
ipam_bluecat.usagePercentage.addressAllocation.unassigned
Percentage of address allocations that are unassigned
ipam_bluecat.usagePercentage.addressAllocation.assigned
Percentage of address allocations that are assigned
type
ipam_bluecat.type
Object type (e.g., IP4Address, IP4Network)
range
ipam_bluecat.range
CIDR range of the subnet or block
subnet_type
ipam_bluecat.subnet_type
Subnet type (e.g., network, block)
name
ipam_bluecat.name
Name assigned to the subnet or block
ipam_bluecat.location.name
Name of the location associated with the subnet
ipam_bluecat.location.id
Internal ID of the location associated with the subnet
Site
Site or location name associated with the subnet
name
Device Name
Name of the subnet
subnet_type
Type
Subnet type
range
prefix
CIDR prefix of the subnet
* Only some attributes map to a Device Security Common Attribute.