ServicesTemporal ServiceWorkflows for Day 2 Operations

InfiniBand PKey Member Update

View as Markdown

Reconciles a PKey’s membership to a declarative list. The submitted list is treated as the desired complete state — current members not in the list are removed, and missing members are added. The UI labels this as “Replace PKey Membership”.

For pure additions, use IB PKey Member Add. For pure removals, use IB PKey Member Delete. Use Update only when you want the PKey to match an exact set.

Removals require approval

When the computed diff contains any removals, the workflow pauses at validate_diff and waits for approval. Additions-only runs auto-approve. Rejection aborts cleanly without modifying Nautobot or UFM.

User Interface

Form Inputs

FieldDescriptionRequired
UFM HostNautobot device name of the UFM server that owns the PKeyYes
PKeyPartition key whose membership is being reconciledYes
Membership Typefull or limited, applied to any newly added members. Defaults to full.Yes
Member SourceBy Interfaces or By GUIDsYes
InterfacesDesired complete list of device + interface rowsWhen Member Source is By Interfaces
GUIDsDesired complete list of 0x + 16 hex GUIDsWhen Member Source is By GUIDs

InfiniBand PKey Member Update workflow form

Workflow Execution

Execution Stages

  1. Resolve site, overlay, and canonical PKey from Nautobot
  2. Resolve desired interfaces to IB GUIDs
  3. Fetch current OverlayAssignments from Nautobot and compute the diff
  4. Review the diff — approval required when members are being removed
  5. Sync OverlayAssignment records in Nautobot
  6. Remove stale GUIDs and add new GUIDs on UFM
  7. Verify final UFM membership matches the desired set