Skip to main content
Version: v5.6.1

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.

FieldTypeMeaning
addressstringNetwork address; "" when not recorded. Indexed, unconstrained.
archivedbooleanShelved but still a member — set and cleared by update.
codestringThe record's code.
created_attimestampWhen the record was created.
created_bystringUsername of the creating identity.
descriptionstring"" when never set.
duplicate_addressbooleanTrue when another non-destroyed infrastructure node in the same environment carries the same address (a warning, never a refusal).
fqdnstringFully qualified domain name; "" when not recorded. Indexed, unconstrained.
idstringThe record's identity.
infrastructure_typestringOne of the closed registry: host, hypervisor, network_device, link.
last_facts_attimestampWhen facts last landed on this node; unset when never.
lifecycle_statestringregistered or deregistered (the manual membership states), or one of the reserved integration-asserted states provisioned and destroyed.
namestringDisplay name.
node_pathstringThe node's own path, e.g. "/projects/web/environments/prod/infrastructure/kvm-mgmt-01".
parent_pathstringThe parent node's path (project, environment or asset).
properties_idstringThe node's own properties document id.
settings_idstringThe node's own settings document id.
updated_attimestampWhen the record was last updated.

InfrastructureFilter​

InfrastructureFilter is the typed predicate vocabulary over the indexed hot columns.

FieldTypeMeaning
addressstringExact address match; "" keeps all.
archivedbooleanKeep only archived (true) or unarchived (false); unset keeps both.
codestringExact code match; "" keeps all.
fqdnstringExact FQDN match; "" keeps all.
include_deregisteredbooleanInclude deregistered rows alongside the rest (the soft-close posture hides them by default).
infrastructure_typestringKeep only one registry type (host, hypervisor, network_device, link); "" keeps all.
lifecycle_statestringKeep only one lifecycle state. "" keeps registered and provisioned; deregistered rows appear only when asked for here or via include_deregistered.
searchstringCase-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.

FieldTypeMeaning
addressstringNetwork address to record; "" stores none.
codestringThe record's code — the batch's match key under the parent.
descriptionstringFree-text description.
fqdnstringFully qualified domain name to record; "" stores none.
infrastructure_typestringOne of the closed registry: host, hypervisor, network_device, link.
namestringDisplay name.
properties_jsonstringReplacement 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.

FieldTypeMeaning
codestringThe record's code.
errorstringThe named refusal when outcome is failed; "" otherwise.
node_idstringThe row's node id; "" when the item failed.
outcomestringcreated, updated or failed.
  • 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.