Integration
Netbox Bridge
By Typed OpenClaw plugin for safe NetBox inventory, IP planning, and guarded REST operations
Install
openclaw plugins install -lREADME
# OpenClaw NetBox Bridge
A typed [OpenClaw](https://github.com/openclaw/openclaw) plugin for NetBox inventory, guarded REST operations, IP planning and power-port workflows.
> **Status:** public beta. The plugin is useful now, while the compatibility matrix, IPv6 rules, response limits and release automation are still being completed.
## What it does
- searches and reads devices, virtual machines, IP addresses and prefixes;
- checks IP availability and prepares device drafts;
- exposes a generic `describe → query → preview → confirm → commit → readback` REST workflow;
- handles multi-PSU power-port updates without accidentally multiplying a device total;
- keeps writes and network probes disabled until explicitly enabled.
## Install from source
```bash
git clone https://github.com/tensorsdynamics/openclaw-netbox-bridge.git
cd openclaw-netbox-bridge
npm ci
npm run check
npm run build
openclaw plugins install -l .
openclaw plugins enable netbox-bridge
```
Then add a configuration like [`examples/openclaw.json`](examples/openclaw.json). Use a dedicated NetBox token with the minimum required permissions. Keep TLS verification enabled.
## Safety model
Reads are available after configuration. Higher-risk actions are fail-closed:
- generic committed REST changes require `enableGenericMutations: true`;
- committed generic changes must match `allowedMutationPrefixes`;
- power writes require `enablePowerWrites: true`;
- network reachability checks require `enableReachabilityProbe: true`;
- writes use `commit=false` by default.
These controls reduce mistakes. They do not replace NetBox RBAC, approval and change-management rules.
## Development
```bash
npm ci
npm run check
npm run build
npm run test:package
npm audit --omit=dev --audit-level=high
```
The package smoke test confirms that an isolated OpenClaw installation registers all plugin tools. The public CI workflow is prepared locally and will be enabled as soon as the repository credential has the GitHub `workflow` scope.
## Repository layout
- `src/` — plugin implementation;
- `test/` — unit and package-install checks;
- `examples/` — sanitized configuration;
- `docs/architecture.md` — design and boundaries;
- `docs/agent-playbook.md` — safe agent procedure;
- `docs/release-roadmap.md` — remaining public work.
No production exporter, dashboard, deployment stack, private hostname, inventory snapshot or secret-manager integration belongs here.
## Security and contributions
Please read [SECURITY.md](SECURITY.md) before reporting a security issue and [CONTRIBUTING.md](CONTRIBUTING.md) before sending a pull request. The project is licensed under [Apache-2.0](LICENSE).
integration
Comments
Sign in to leave a comment