Infrastructure node
packs:infrastructure
An infrastructure node is one managed host, hypervisor, network device or
link recorded in the estate tree under a project, environment or asset.
Nodes are registered one at a time or upserted in batches (an integration
feed's natural shape), updated, archived and deregistered rather than
deleted — membership closes softly, keeping history. The hot columns ride
the row; the long tail of configuration lives in the node's properties
document. Served by the v2 InfrastructureService
(ListInfrastructureNodes, GetInfrastructureNode,
RegisterInfrastructureNode, UpsertInfrastructureNodes,
UpdateInfrastructureNode, DeregisterInfrastructureNode); writes are
authorised like other node writes, on the parent's infrastructure rule
path, 404-on-deny.
InfrastructureNode
InfrastructureNode is one infrastructure node row: the indexed hot columns plus identity. The long tail of configuration lives in the node's properties document, served on the get.
| Field | Type | Meaning |
|---|---|---|
address | string | Network address; "" when not recorded. Indexed, unconstrained. |
archived | boolean | Shelved but still a member — set and cleared by update. |
code | string | The record's code. |
created_at | timestamp | When the record was created. |
created_by | string | Username of the creating identity. |
description | string | "" when never set. |
duplicate_address | boolean | True when another non-destroyed infrastructure node in the same environment carries the same address (a warning, never a refusal). |
fqdn | string | Fully qualified domain name; "" when not recorded. Indexed, unconstrained. |
id | string | The record's identity. |
infrastructure_type | string | One of the closed registry: host, hypervisor, network_device, link. |
last_facts_at | timestamp | When facts last landed on this node; unset when never. |
lifecycle_state | string | registered or deregistered (the manual membership states), or one of the reserved integration-asserted states provisioned and destroyed. |
name | string | Display name. |
node_path | string | The node's own path, e.g. "/projects/web/environments/prod/infrastructure/kvm-mgmt-01". |
parent_path | string | The parent node's path (project, environment or asset). |
properties_id | string | The node's own properties document id. |
settings_id | string | The node's own settings document id. |
updated_at | timestamp | When the record was last updated. |
InfrastructureFilter
InfrastructureFilter is the typed predicate vocabulary over the indexed hot columns.
| Field | Type | Meaning |
|---|---|---|
address | string | Exact address match; "" keeps all. |
archived | boolean | Keep only archived (true) or unarchived (false); unset keeps both. |
code | string | Exact code match; "" keeps all. |
fqdn | string | Exact FQDN match; "" keeps all. |
include_deregistered | boolean | Include deregistered rows alongside the rest (the soft-close posture hides them by default). |
infrastructure_type | string | Keep only one registry type (host, hypervisor, network_device, link); "" keeps all. |
lifecycle_state | string | Keep only one lifecycle state. "" keeps registered and provisioned; deregistered rows appear only when asked for here or via include_deregistered. |
search | string | Case-insensitive substring over name and code; "" keeps all. |
InfrastructureUpsertItem
InfrastructureUpsertItem is one batch row: RegisterInfrastructureNode's fields, applied as a create when the code is new under the parent and as an update otherwise.
| Field | Type | Meaning |
|---|---|---|
address | string | Network address to record; "" stores none. |
code | string | The record's code — the batch's match key under the parent. |
description | string | Free-text description. |
fqdn | string | Fully qualified domain name to record; "" stores none. |
infrastructure_type | string | One of the closed registry: host, hypervisor, network_device, link. |
name | string | Display name. |
properties_json | string | Replacement properties document as JSON text; "" leaves an existing node's document untouched (and stores an empty one on create). |
InfrastructureUpsertResult
InfrastructureUpsertResult is one batch item's outcome.
| Field | Type | Meaning |
|---|---|---|
code | string | The record's code. |
error | string | The named refusal when outcome is failed; "" otherwise. |
node_id | string | The row's node id; "" when the item failed. |
outcome | string | created, updated or failed. |
Related pages
opschain docs infrastructure-nodes— the component page: lifecycle, facts, integration feeds.opschain docs packs-infrastructure— the pack whose actions manage these hosts.opschain docs resources/properties— the properties document the row references.