VRF: VRF
Virtual Routing and Forwarding instance that provides isolated routing domains for IP address space separation.
VRF definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches VRF.Entity properties
| Property | Value |
|---|---|
| Entity code | VRF |
| Display name | VRF |
| Plural | VRFs |
| Level | 41000 |
Use cases
Virtual Routing and Forwarding instance that provides isolated routing domains for IP address space separation.
VRF (Virtual Routing and Forwarding) creates isolated routing tables within the network, allowing overlapping IP address space across different tenants, environments, or security zones. Each VRF has a unique Route Distinguisher (RD) that makes routes globally unique in MPLS/BGP environments. The enforceUnique flag controls whether IP addresses within this VRF must be unique - critical for production VRFs but can be relaxed for lab/test environments. Import and export Route Targets (ROUTETARGET lookups) control route leaking between VRFs. The related lists show all PREFIXes and IPADDRESSes assigned to this VRF, providing a complete view of the address space within this routing domain. VRFs map to real device configurations (VRF-lite, MPLS L3VPN) and are essential for multi-tenant environments.
Fields
VRF Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | VRF name as configured on devices |
rd | text | Format: ASN:NN or IP:NN (e.g., 65000:100 or 10.0.0.1:100) | |
description | text (multi-line) | Description. | |
enforceUnique | boolean | Prevent duplicate IP addresses within this VRF | |
status | enum | Valid ids: 1 (Active), 2 (Planned), 3 (Deprecated). |
Route Targets
| Field | Type | Required | Notes |
|---|---|---|---|
importTargets | array of references → ROUTETARGET | Route targets to import into this VRF | |
exportTargets | array of references → ROUTETARGET | Route targets to export from this VRF |
Attachments and additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
importTargetspoints at multipleROUTETARGETrecord;exportTargetspoints at multipleROUTETARGETrecord. - Related lists:
PREFIXvia objectRef;IPADDRESSvia objectRef.
Creating a VRF via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "VRF",
"level": 41000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"description": "Example text",
"status": "1"
}
Listing VRFs
GET /v1/entities/VRF/SUB