BOM Scope Rules

Public Preview: Asset Lifecycle is in public preview. The functionality and API surface may evolve in future releases.

A BOM scope rule filters objects in NetBox to determine which should be included in (or excluded from) the scope of a BOM. Each rule references one or more object types and a set of filter parameters, which are evaluated using the target model's native filterset when the BOM is generated.

Rules are evaluated per object type. For a given type, the union of all include rules produces the initial candidate set; any objects matched by an exclude rule for the same type are then removed. Cables without an assigned type and racks without an assigned rack type are silently dropped during evaluation, as they cannot be resolved to a unique line item.

Fields

BOM

The BOM to which this rule applies.

Object Types

The NetBox content types the rule targets. Supported types are dcim.rack, dcim.device, dcim.module, and dcim.cable. A single rule may target more than one type, in which case the same filter parameters are applied to each.

Enabled

If not checked, this rule is retained on the BOM but ignored during generation.

Action

Determines how matched objects are treated. One of:

• Include (default) - Add matched objects to the BOM's scope.
• Exclude - Remove matched objects from the BOM's scope.

Parameters

A JSON object of filter parameters passed to the target model's filterset. The accepted keys and values correspond to the filters exposed by the underlying NetBox model (for example, site_id, role_id, status, or tag). An empty object matches every object of the selected types.