FHRPGROUP: FHRP Group
First Hop Redundancy Protocol group providing gateway redundancy via VRRP, HSRP, GLBP, or CARP.
FHRPGROUP 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 FHRPGROUP.Entity properties
| Property | Value |
|---|---|
| Entity code | FHRPGROUP |
| Display name | FHRP Group |
| Plural | FHRP Groups |
| Level | 42000 |
Use cases
FHRPGROUP models a First Hop Redundancy Protocol instance that provides default gateway redundancy. Multiple physical routers/switches share a virtual IP address (VIP) so that if the active gateway fails, a standby takes over transparently. The protocol field supports VRRP (industry standard), HSRP (Cisco), GLBP (Cisco, load-balancing), and CARP (BSD). The groupId is the protocol-specific group number. The virtualIp links to an IPADDRESS record (with role VIP/VRRP/HSRP/GLBP). Priority and preempt control failover behaviour. Authentication tracks the shared secret. The members related list shows COMPPORTINV interfaces participating in this FHRP group.
Fields
FHRP Group Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
protocol | enum | Yes | Valid ids: 1 (VRRP v2), 2 (VRRP v3), 3 (HSRP v1), 4 (HSRP v2), 5 (GLBP), 6 (CARP). |
groupId | number | Yes | Protocol group number |
virtualIp | reference → IPADDRESS | Shared virtual IP address | |
description | text (multi-line) | Description. |
Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
priority | number | Higher priority = more likely to be active | |
preempt | boolean | Allow higher-priority router to reclaim active role | |
authType | enum | Valid ids: 1 (None), 2 (Plain Text), 3 (MD5). | |
status | enum | Valid ids: 1 (Active), 2 (Planned), 3 (Deprecated). |
Relationships
- Lookup:
virtualIp(reference →IPADDRESS).
Creating a FHRP Group via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "FHRPGROUP",
"level": 42000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"protocol": "1",
"groupId": 0,
"description": "Example value"
}Listing FHRP Groups records
GET /v1/entities/FHRPGROUP/SUB:<your-sub-id>