Look up NetBox asset
malcolm_netbox_lookupRead-only
Resolve an IP, device name, or prefix to its NetBox asset (role, site, tenant) to identify whether observed traffic involves a known asset and where it sits.
Instructions
Resolve an IP, device name, or prefix to its NetBox asset (role, site, tenant).
Use this to tell whether observed traffic involves a known asset and where it
sits — the fast path for the three common NetBox lookups. For any other NetBox
endpoint (services, VLANs, interfaces, VMs, contacts) use malcolm_netbox_query;
to list sites use malcolm_netbox_sites. Pass at least one of ip/device/prefix.
Returns a JSON object with a summarized section per lookup you supplied; a
lookup that fails carries its own error key while the others still answer,
and every one failing is reported as an error rather than as a result.
NetBox is an optional Malcolm subsystem, so found=false is ambiguous on
its own: malcolm_service_status carries a netbox readiness key, and that
key is what separates "this asset is not in the inventory" from "this
deployment has no inventory".
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ip | No | IP address to resolve to its NetBox asset, e.g. "192.0.2.77". Empty = skip the IP lookup. | |
| device | No | Device name to search for, e.g. "switch-01". Empty = skip the device lookup. | |
| prefix | No | Network prefix to query, e.g. "192.0.2.0/24". Empty = skip the prefix lookup. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |