Skip to content

Catalog: NICs, cables, transceivers ​

Besides device templates, the <Catalog> holds parts that are reused across devices and links: NIC cards, cable models and transceivers.

Standalone NIC ​

A NIC card model, inserted into device templates with <Nic template="id"> (see A NIC inserted from a standalone NIC).

xml
<Nic id="cx7-2p" model="ConnectX-7 2P" manufacturer="NVIDIA"
     portCount="2" speed="200G" connector="QSFP56"
     layout={{ x: 0, y: 0, cols: 2, w: 380, h: 57 }} />
AttributeRequiredDefaultValid values / description
idyesUnique across every catalog entry
model, manufacturerno""Free text
portCountno1Whole number
speedno10GSpeed
connectornoRJ45Connector
breakoutno2 or 4
layoutnoHow the ports are arranged (cols, rows, groupSize) and the faceplate size (w, h; left out to fit the ports). x and y are always 0: where the card sits is up to each device template
facing, adjacentRows, alignnoSee Layout object

Cable template ​

A cable model. Topology cables reference it with template="id" and inherit its material, mode, speed and link assembly, read-only. Editing the template in Materials → Cables updates every cable that uses it.

xml
<Cable id="dr4-400g-5m" model="400G DR4 5m link" manufacturer="NVIDIA"
       speed="400G" connector="OSFP" material="fiber" mode="active">
  <Transceiver model="MMS1V00-WM" manufacturer="NVIDIA" connector="QSFP-DD" speed="400G" modulation="4x100Gb/s PAM4" />
  <Fiber model="MFP7E30-N005" manufacturer="NVIDIA" length="5m" connector="MPO12 APC to MPO12 APC" />
  <Transceiver model="MMS4X00-NS400" manufacturer="NVIDIA" connector="OSFP" speed="400G" modulation="4x100Gb/s PAM4" />
</Cable>
AttributeRequiredDefaultValid values / description
idyesUnique across every catalog entry
model, manufacturerno""Free text
speedno10GSpeed: the rated speed (capacity)
connectornoRJ45Connector
materialnocopper or fiber
modenoactive or passive

A cable template may carry a link assembly — the same syntax as on a topology cable. A catalog cable never carries labels, length, negotiatedSpeed, link or serial numbers; those describe one installed link.

Common cable kinds:

KindmaterialmodeAssembly middle part
AOC / optics + fiberfiberactive<Fiber>
DAC (direct attach copper)copperpassive<Copper>
ACC (active copper)copperactive<Copper>

Transceiver template ​

A pluggable optic model.

xml
<Transceiver id="qsfp28-sr4" model="MMA1B00-C100D" manufacturer="NVIDIA"
             formFactor="QSFP28" />
<Transceiver id="qsfp28-4x25" model="Breakout optic" manufacturer="Generic"
             formFactor="QSFP28" breakout="4" outputConnector="SFP28" />
AttributeRequiredDefaultValid values / description
idyesUnique across every catalog entry
model, manufacturerno""Free text
formFactornoQSFP28Connector: the cage it fits
breakoutno2 or 4
outputConnectornoConnector of the breakout outputs

Two kinds of <Transceiver>

A <Transceiver> directly inside <Catalog> is a reusable template keyed by id and formFactor. A <Transceiver> inside a <Cable> is one end of that cable's link assembly.