opaxlattopology

Generates a topology XML file of a cluster using topology.csv, linksum_swd06.csv, and linksum_swd24.csv as input. The topology file can be used to bring up and verify the cluster.

Note: The topology.csv input file must be present in the same directory from which the script operates, but the linksum CSV files are read from the /usr/share/opa/samples directory.

Syntax

opaxlattopology [-d level] [-v level] [-i level] [-K] [-s hfi_suffix] [source [dest]]

Options

--help

Produces full help text.

-d level

Specifies the output detail level. Default = 0. Levels are additive.

By default, the top level is always produced. Switch, rack, and rack group topology files can be added to the output by choosing the appropriate level. If the output at the group or rack level is specified, then group or rack names must be provided in the spreadsheet. Detailed output can be specified in any combination. A directory for each topology XML file is created hierarchically, with group directories (if specified) at the highest level, followed by rack and switch directories (if specified).

1

Intel® Omni-Path Edge Switch 100 Series topology files.

2

Rack topology files.

4

Rack group topology files.

-v level

Specifies the verbose level. Range = 0 - 8. Default = 2.

0

No output.

1

Progress output.

2

Reserved.

4

Time stamps.

8

Reserved.

-i level

Specifies the output indent level. Range = 0 - 15. Default = 0.

-K

Specifies DO NOT clean temporary files.

Prevents temporary files in each topology directory from being removed. Temporary files contain CSV formatted lists of links, HFIs, and switches used to create a topology XML file. Temporary files are not typically needed after a topology file is created, however they are used for creating linksum_swd06.csv and linksum_swd24.csv files, or can be retained for subsequent inspection or processing.

-s hfi_suffix

Used on Multi-Rail or Multi-Plane fabrics. Can be used to override the default hfi1_0.

For Multi-Plane fabric, use the tool multiple times with a different hfi-suffix.

For Multi-Rail fabric, specify HostName as "HostName HfiName" in the spreadsheet.

Description

The opaxlattopology script reads the topology.csv file from the local directory, and reads the other files from /usr/share/opa/samples/linksum_swd06.csv and /usr/share/opa/samples/linksum_swd24.csv. The topology.csv file is created from the topology.xlsx spreadsheet by saving the Fabric Links tab as a .CSV file to topology.csv. A sample topology.xlsx is located in the /usr/share/opa/samples/ directory. Inspect the topology.csv file to ensure that each row contains the correct and same number of comma separators. Any extraneous entries in the spreadsheet can cause the CSV output to have extra fields.

The script outputs one or more topology files starting with topology.0:0.xml. The topology.csv input file must be present in the same directory from which the script operates, but the linksum CSV files are read from the /usr/share/opa/samples directory.

Example

opaxlattopology 
# reads default input 'topology.csv' and creates default
# output 'topology.0:0.xml'

opaxlattopology  fabric_2.csv
# reads input 'fabric_2.csv' and creates default output

See topology.xlsx for examples of links between HFI and Edge SW (rows 4-7), HFI and Core SW (rows 8-11), and Edge SW and Core SW (rows 12-15).

Environment Variables

The following environment variables allow user-specified MTU.

MTU_SW_SW

If set, it overrides default MTU on switch-to-switch links. Default = 10240

MTU_SW_HFI

If set, it overrides default MTU on switch-to-HFI links. Default = 10240

Creating linksum Files

The linksum_swd06.csv and linksum_swd24.csv files are provided as stand-alone files in the /usr/share/opa/samples directory. However, they can be recreated (or modified) from the spreadsheet, if needed, by performing the following steps:

  1. Save each of the following from the topology.xlsx file as individual .csv files:
    • Internal SWD06 Links tab as linksum_swd06.csv
    • Internal SWD24 Links tab as linksum_swd24.csv
    • Fabric Links tab as topology.csv
  2. For each saved topology.csv file, run the script with the -K option.
  3. Upon completion of the script, save the top level linksum.csv file as linksum_swd06.csv or linksum_swd24.csv as appropriate.

Multi Rail and Multi Plane Fabrics

By default, the opaxlattopology script considers all of the hosts to have a single HFI (hfi1_0).

For Multi Rail/Plane fabrics, the user has following options: