COMPPORTINV: Port
The COMPPORTINV entity stores ports. Installed port instance on a deployed asset, with actual MAC address and physical connection references.
Default definition. This article describes the default
COMPPORTINV 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 COMPPORTINV.Entity properties
| Property | Value |
|---|---|
| Entity code | COMPPORTINV |
| Display name | Port |
| Plural | Ports |
| Level | 100000 |
Use cases
COMPPORTINV is the inventory side of the port dual model (catalogue: COMPPORT, inventory: COMPPORTINV). While COMPPORT defines the port template on a catalogue component, COMPPORTINV represents an actual port on a deployed COMPINV asset.
Fields
Basic Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name |
ref | text | Reference | |
portname | text | Interface name (e.g. GigE0/1, eth0, Fa0/24) | |
description | text (multi-line) | Description | |
portType | enum | Port Type. Valid ids: ethernet (Ethernet), fibre (Fibre), console (Console), management (Management), serial (Serial), usb (USB), power (Power), other (Other). | |
speed | enum | Speed. Valid ids: 100m (100 Mbps), 1g (1 Gbps), 2.5g (2.5 Gbps), 5g (5 Gbps), 10g (10 Gbps), 25g (25 Gbps), 40g (40 Gbps), 100g (100 Gbps), 400g (400 Gbps). | |
mediaType | enum | Media Type. Valid ids: copperRj45 (Copper (RJ45)), fibreMm (Fibre (Multi-Mode)), fibreSm (Fibre (Single-Mode)), dac (DAC (Direct Attach)), aoc (AOC (Active Optical)), other (Other). |
Status & Addressing
| Field | Type | Required | Notes |
|---|---|---|---|
adminStatus | enum | Admin Status. Valid ids: up (Up), down (Down), disabled (Disabled). | |
operStatus | enum | Operational Status. Valid ids: up (Up), down (Down), testing (Testing), unknown (Unknown). | |
macaddress | text | MAC Address | |
ipAddress | text | If this is a Layer 3 interface | |
subnetMask | text | Subnet Mask | |
vlan | text | VLAN ID, or 'trunk' for trunk ports | |
protocol | enum | Transport or signalling protocol on this interface. Valid ids: ethernet (Ethernet), sdh (SDH / SONET), otn (OTN), dwdm (DWDM), cwdm (CWDM), fibreChannel (Fibre Channel), infiniband (InfiniBand), mpls (MPLS), atm (ATM), frameRelay (Frame Relay), pdh (PDH (E1/T1/E3/T3)), other (Other). | |
duplex | enum | Duplex. Valid ids: full (Full), half (Half), auto (Auto). |
Transceiver & Audit
| Field | Type | Required | Notes |
|---|---|---|---|
transceiver | reference → SUBCOMPINV | SFP/QSFP module installed in this port | |
transceiverType | text | e.g. SFP-10G-SR, QSFP-40G-LR4 | |
lastTrafficDate | date | When traffic was last observed on this port | |
avgTrafficMbps | number | Average traffic from last monitoring period | |
peakTrafficMbps | number | Peak Traffic (Mbps) | |
errorCount | number | CRC/alignment errors from last poll | |
discardCount | number | Discard Count | |
poeEnabled | boolean | PoE Enabled | |
poeDrawW | number | PoE Draw (W) |
Relationships
- Lookups:
transceiverpoints at aSUBCOMPINVrecord. - Related lists:
CONNECTION(port).
Creating a Port via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "COMPPORTINV",
"level": 100000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example value",
"portname": "Example value",
"description": "Example value"
}Listing Ports
GET /v1/entities/COMPPORTINV/SUB