SSSRMAP Network XML documentation

This page attempts to document the network XML that we have added to the SSSMRAP protocol.

Example

<Network type="Infiniband">
  <Device>
    <ID>000255000001b000</ID>
    <Vendor>SomeVendor</Vendor>
    <Lid>44</Lid>
    <Description>Bogus InfiniBand Adapter</Description>
    <Type>HCA</Type>
    <Ports>
      <PortCount>2</PortCount>
      <Port>
        <Number>1</Number>
        <State>Up</State>
        <RemoteDevice port="2">000255000001b080</RemoteDevice>
        <SendBytes units="bytes">0</SendBytes>
        <ReceiveBytes units="bytes">0</SendBytes>
        <SendRate units="bits/sec">0</SendRate>
        <SendRate units="packets/sec">0</SendRate>
        <ReceiveRate units="bits/sec">0</SendRate>
        <ReceiveRate units="packets/sec">0</SendRate>
        <SymbolErrors>0</SymbolErrors>
        <SymbolErrorsRate>0</SymbolErrorsRate>
        <LastSeen>Wed Dec 31 18:00:00 1969</LastSeen>
        <Width>12X</Width>
        <Speed units="Gigabits/sec">2.5</Speed>
        <Capacity units="Gigabits/sec">24</Capacity>
      </Port>
    </Ports>
  </Device>
</Network>

Elements

The Network element

The Network element encapsulates the rest of the data. It occurs in a standard SSSRMAP Node element. It has one attribute, type, which contains the type of network stack the element reflects (currently only "Infiniband" is supported).

The Device element

The Network element contains Device elements, one for each network device for that networking stack on that node.

The device contains the following elements:

ID
The GUID or MAC address of the network device.
Vendor
The name of the device's vendor/manufacturer.
Lid
In InfiniBand, provides the LID of that particular device.
Description
A textual description of the device.
Type
The type of device. One of 'HCA' or 'Switch'.
Ports
A description of the various ports on the device. It contains a PortCount? element, containing the number of ports on the device as a decimal integer, and a Port element for each port for which data is available or of interest. The Port element is covered in its own section.

The Port element

The Port element describes a port on a newtork device. It contains the following elements:

Number
The port's number (indexed from 1).
State
The port's state, one of "Up" or "Down".
RemoteDevice
The GUID of the device to which this port is connected. It has one attribute, port, which specifies the port on the remote device to which the connection is made.
SendBytes/ReceiveBytes
The number of bytes sent or received over this port.
SendRate/ReceiveRate
The rate at which data is being sent or received over this port. It has an attribute, units. units can be either "bits/sec" or "packets/sec".
SymbolErrors
The number of symbol errors on this port
SymbolErrorsRate
The rate at which symbol errors are accumulating. This element needs to be better-defined.
Width
The width of the InfiniBand link
Speed/Capacity
Speed' is the signalling speed (raw data rate) of the port, and Capacity is the payload capacity (total speed less packetization and other overhead) of the port. Each of these elements accepts a units attribute, which specifies the units (such as "Gigabits/sec") in which the rate is reported.

The speed and capacity are assumed to be each direction of a full-duplex link. In the future, if actual direction needs to be communicated, an attribute called direction may be added, accepting the following values:

send/receive
The capacity or speed is the rate at which this port can send (or receive) data, as indicated.
each
The capacity is the one-way capacity on a full-duplex link. This must be the default value, for compatibility with the current implementation.
both
The capacity is the aggregate send and receive maximum (for half-duplex links).