Skip to content

HOWTO: Configure REQUIRE_IPAM Enforcement for a Module

REQUIRE_IPAM is a contract-level constraint that prevents a HyOps provisioning module from running unless every target IP address has an active NetBox allocation. This HOWTO covers enabling the constraint in a module contract, configuring the NetBox query parameters used to validate allocations at preflight, and testing the enforcement in a dev environment before applying it to production. The constraint is the enforcement mechanism behind the "no ad hoc addressing" governance rule.

What this covers:

  • REQUIRE_IPAM constraint declaration in the module contract and its preflight evaluation
  • NetBox query parameters for allocation validation: prefix scope, status filter, and tag requirements
  • Testing the enforcement: confirming blocked runs on missing allocations and clean runs on valid ones

Learn this in Academy: IPAM-Driven Infrastructure track