1
2eth2rm(8)                    EFSFFCLIRG (Man Page)                   eth2rm(8)
3
4
5

NAME

7       eth2rm
8
9
10
11       Permits  the  generation  of  configuration files for FastFabric or re‐
12       source managers from a topology xml file.
13
14       When using a topology spreadsheet and  ethxlattopology  to  design  and
15       prepare  for deployment verification of a fabric, eth2rm may be used to
16       generate resource manager configuration from the  planned  cluster  de‐
17       sign.  Using this approach will allow the resulting configuration files
18       to be complete, even if some nodes in the fabric have not yet been  in‐
19       stalled  or  made operational. Alternatively, ethreport -o topology can
20       be used to generate a topology XML file for input to  eth2rm.  In  this
21       case, only the currently present nodes will be included.
22
23       When working with SLURM, the eth2rm -o slurm option should typically be
24       used. This option will generate a SLURM configuration file  that  lists
25       the  hosts  directly  connected  to each switch in a syntax that can be
26       used by SLURM's topology/tree plugin. It also generates a single "fake"
27       switch  shown  as  connecting all the other switches together. This ap‐
28       proach allows for SLURM job placement to  be  improved  while  avoiding
29       undo overhead in SLURM. This option also allows for topologies that are
30       not a pure fat-tree.
31
32       When the configuration is a pure fat tree or oversubscribed  fat  tree,
33       the  eth2rm  -o  slurmfull  option may be used to generate the full de‐
34       scription of the fabric, including all intermediate and  core  switches
35       in  the  fat tree topology. This option may permit better job placement
36       optimization than the output from the eth2rm -o slurm  option.  However
37       for larger fabrics, it may also increase the overhead within SLURM.
38

Syntax

40       eth2rm  [-v]  [-q]  -o   output [-g|-u|-t] [-F  point] [-p  prefix] [-s
41       suffix] topology_input
42

Options

44       --help
45
46                 Produces full help text.
47
48
49       -v/--verbose
50
51                 Specifies verbose output.
52
53
54       -q/--quiet
55
56                 Disables progress reports.
57
58
59       -o/--output output
60
61                 Specifies the output type:
62
63
64
65
66                 slurm
67                           SLURM tree nodes. Supports a variety of topologies.
68
69
70
71
72
73                 slurmfull SLURM fat tree nodes and ISLs. Only  supports  pure
74                           trees.
75
76
77
78
79
80                 hosts     FastFabric hosts file omitting this host
81
82
83
84       -g/--guid
85
86                 Specifies the output switch GUIDs instead of names.
87
88
89       -u/--underscore
90
91                 Changes spaces in switch names to underscores.
92
93
94       -t/--trunc
95
96                 Truncates switch names at first space.
97
98
99                 This  will  treat  large  director  switches as a single, big
100                 switch.
101
102                 If -g, -u or -t are not specified, the switch name's  suffix,
103                 after  the  first  space,  will be placed at the start of the
104                 name. For example, 'core5 Leaf 101' becomes 'Leaf101_core5'.
105
106       -p/--prefix prefix
107
108                 Specifies the prefix to prepend to all NIC hostnames.
109
110
111       -s/--suffix suffix
112
113                 Specifies the suffix to append to all NIC hostnames.
114
115
116       -F/--focus point
117
118                 Specifies the focus area for output. Limits the scope of out‐
119                 put to links that match any of the given focus points. May be
120                 specified up to 10 times.
121
122
123       -C/--check
124
125                 Performs more topology file validation. Requires all links to
126                 resolve  against  nodes,  all nodes connected to same fabric,
127                 and treats any resolution errors as fatal.
128
129
130       -S/--strict
131
132                 Performs strict topology file validation. Performs all checks
133                 in  -C,  and  requires all nodes to list PortNum and all node
134                 list ports used.
135
136
137       topology_input
138
139                 Specifies the topology_input file to use. '-' may be used  to
140                 specify stdin.
141
142

Point Syntax

144       node:value
145
146                 value is node description (node name).
147
148
149       node:value1:port:value2
150
151                 value1  is  node description (node name); value2 is port num‐
152                 ber.
153
154
155       nodepat:value
156
157                 value is glob pattern for node description (node name).
158
159
160       nodepat:value1:port:value2
161
162                 value1 is glob pattern  for  node  description  (node  name);
163                 value2 is port number.
164
165
166       nodetype:value
167
168                 value is node type (SW or NIC).
169
170
171       nodetype:value1:port:value2
172
173                 value1 is node type (SW or NIC); value2 is port number.
174
175
176       rate:value
177
178                 value is string for rate (25g, 50g, 75g, 100g).
179
180
181       mtucap:value
182
183                 value  is  MTU  size  (2048, 4096, 8192, 10240); omits switch
184                 mgmt port 0.
185
186
187       linkdetpat:value
188
189                 value is glob pattern for link details.
190
191
192       portdetpat:value
193
194                 value is glob pattern for port details to value.
195
196

Examples

198       eth2rm -o slurm topology.xml
199
200       eth2rm -o slurm -F 'nodepat:compute*' -F 'nodepat:ethcore1 *'
201       topology.xml
202
203       eth2rm -o nodes -F 'nodedetpat:compute*' topology.xml
204
205       eth2rm -o hosts topology.xml
206
207
208
209Copyright(C) 2020-2022         Intel Corporation                     eth2rm(8)