1
2opagenswitches(8)      Master map: IFSFFCLIRG (Man Page)     opagenswitches(8)
3
4
5

NAME

7       opagenswitches
8
9
10
11       Analyzes  the  present fabric and produces a list of Externally Managed
12       switches in the required format for the /etc/opa/switches file.
13

Syntax

15       opagenswitches [-t portsfile] [-p ports] [-R] [-L switches_file]
16       [-o output_file] [-T topology_file] [-X snapshot_file] [-s] [-v  level]
17       [-K]
18

Options

20       --help    Produces full help text.
21
22       -t portsfile
23                 Specifies  the  file  with  list  of  local HFI ports used to
24                 access fabric(s) for analysis.
25                 Default is /etc/opa/ports file.
26
27       -p ports  Specifies the list of local HFI ports used to access  fabrics
28                 for counter clear.
29
30
31                 Default  is first active port. The first HFI in the system is
32                 1. The first port on an HFI is 1. Uses the format hfi:port,
33                 for example:
34
35
36
37                 0:0       First active port in system.
38
39
40
41
42
43                 0:y       Port y within system.
44
45
46
47
48
49                 x:0       First active port on HFI x.
50
51
52
53
54
55                 x:y       HFI x, port y.
56
57
58
59       -R        Does not attempt to get routes for computation of distance.
60
61       -s        Updates/resolves switch names using topology XML data.
62
63       -L switches_file
64                 Specifies the name of a pre-existing switches_file to be used
65                 as input in conjunction with a topology file. When specified,
66                 the file is used instead of switches data obtained  from  the
67                 actual  fabric. The updated switches data is output to stdout
68                 (common to all opagenswitches operations). Does not  generate
69                 switches data. Must also use -s option.
70
71
72       -o output_file
73                 Writes switches data to output_file. Default is stdout.
74
75       -T topology_file
76                 Specifies  topology_file to use. May contain '%P' . Must also
77                 use -s.
78
79
80                 Link data in the topology file is compared to  actual  fabric
81                 link  data  (obtained  by  opareport -o links or opareport -X
82                 snapshot -o links). The data is also matched  to  a  list  of
83                 switch  node  GUIDs and the switch NodeDesc values are gener‐
84                 ated. This list is then  applied  to  the  switches  data  to
85                 update  NodeDesc values. The comparison of topology link data
86                 to actual fabric link data starts with the  host  names.  The
87                 host  names  in  the  actual  fabric  must match those in the
88                 topology file for the comparison  to  succeed.  However,  the
89                 comparison  logic  allows for some mismatches, which could be
90                 due to swapped or missing cables. Switch NodeDesc values  are
91                 matched to GUIDs based on which switch has the greater number
92                 of matching links.
93
94       -X snapshot_file
95                 Uses snapshot_file XML for fabric link information.
96                 May contain '%P' . Must also use -s.
97
98       -v level  Specifies the verbose level. Default = 0. Values include:
99
100
101
102                 0         No output.
103
104
105
106
107                 1         Progress output.
108
109
110
111
112                 2         Reserved.
113
114
115
116
117                 4         Time stamps.
118
119
120
121
122                 8         Reserved.
123
124
125       -K        Does not clean temporary files. Temporary files are CSV  for‐
126                 mat  and contain lists of links used during script operation.
127                 The files are not normally needed after execution,  but  they
128                 can be retained for subsequent inspection or processing.
129
130

Environment Variables

132       The following environment variables are also used by this command:
133
134       PORTS     List of ports, used in absence of -t and -p.
135
136       PORTS_FILE
137                 File containing list of ports, used in absence of -t and -p.
138
139       FF_TOPOLOGY_FILE
140                 File containing topology XML data, used in absence of -T.
141

Examples

143       opagenswitches
144       opagenswitches -p '1:1 2:1'
145       opagenswitches -o switches
146       opagenswitches -s -o switches
147       opagenswitches -L switches -s -o switches
148       opagenswitches -s -T topology.%P.xml
149       opagenswitches -L switches -s -T topology.%P.xml -X snapshot.%P.xml
150
151
152
153Copyright(C) 2015-2018         Intel Corporation             opagenswitches(8)