opadisableports.manPage 3.35 KB
Newer Older
John Fleck's avatar
John Fleck committed
1 2
.\" .\" *********************************************************************
.\" .\" *                                                                   *
3
.\" .\" *             Copyright 2015-2016, Intel Corporation                *
John Fleck's avatar
John Fleck committed
4 5 6 7 8
.\" .\" *                                                                   *
.\" .\" *                       All Rights Reserved.                        *
.\" .\" *                                                                   *
.\" .\" *********************************************************************

9
.TH opadisableports 8 "Intel Corporation" "Copyright(C) 2015\-2016" "Master map: IFSFFCLIRG (Man Page)" 
John Fleck's avatar
John Fleck committed
10 11 12 13 14 15 16 17
.SH NAME
opadisableports

.NL

.PP

\fB(Linux)\fR
18
Accepts a CSV file listing links to disable. For each HFI-SW link, the switch side of the link is disabled. For each SW-SW link, the side of the link with the lower LID (typically, the side closest to the SM) is disabled. This approach generally permits a future opaenableports operation to re-enable the port once the issue is corrected or ready to be retested. When using the -R option, this tool does not look at the routes, it disables the switch ports with the lower value LID. The list of disabled ports is tracked in /etc/sysconfig/opa/disabled*.csv.
John Fleck's avatar
John Fleck committed
19 20 21 22 23 24 25 26 27 28 29 30 31
.SH Syntax 
.NL
opadisableports [-R] [-t \fIportsfile\fR] [-p \fIports\fR] [ \fIreason\fR] < disable.csv
.PP
or
.br
opadisableports --help
.SH Options 
.NL

.TP 10
--help 
.NL
32 33
Produces full help text.

John Fleck's avatar
John Fleck committed
34 35 36
.TP 10
-R 
.NL
37 38
Does not attempt to get routes for computation of distance. Instead, disables switch port with lower LID assuming that it is closer to this node.

John Fleck's avatar
John Fleck committed
39 40 41
.TP 10
-t \fIportsfile\fR 
.NL
42 43
File with list of local HFI ports used to access fabric(s) for operation. Default is /etc/sysconfig/opa/ports.

John Fleck's avatar
John Fleck committed
44 45 46
.TP 10
-p \fIports\fR 
.NL
47 48 49 50 51 52
List of local HFI ports used to access fabric(s) for analysis. Default is first active port. The first HFI in the system is 1. The first port on an HFI is 1.

.IP
Uses the format hfi:port, for example:
.RS
.TP 10
John Fleck's avatar
John Fleck committed
53 54 55 56

.sp
0:0 
First active port in system.
57 58 59 60 61 62

.RE

.RS
.TP 10

John Fleck's avatar
John Fleck committed
63 64
.sp
0:y 
65 66 67 68 69 70 71
Port  \fIy\fR within system.

.RE

.RS
.TP 10

John Fleck's avatar
John Fleck committed
72 73
.sp
x:0 
74 75 76 77 78 79 80
First active port on HFI  \fIx\fR.

.RE

.RS
.TP 10

John Fleck's avatar
John Fleck committed
81 82
.sp
x:y 
83 84 85 86
HFI  \fIx\fR, port  \fIy\fR.

.RE

John Fleck's avatar
John Fleck committed
87 88 89
.TP 10
 \fIreason\fR 
.NL
90 91
Optional text describing why ports are being disabled. If used, text is saved at the end of any new lines in the disabled file. For ports already in the disabled file, this is ignored.

John Fleck's avatar
John Fleck committed
92 93 94
.TP 10
disable.csv 
.NL
95
File listing the links to disable. The list is of the form: NodeGUID; PortNum; NodeType; NodeDesc; NodeGUID; PortNum; NodeType; NodeDesc; Reason 
John Fleck's avatar
John Fleck committed
96 97

.IP
98
For each listed link, the switch port with the lower LID (closer to the SM) is disabled. The  \fIreason\fR field is optional. The  \fIreason\fR field and any additional fields provided are saved in the disabled file. An input file such as this can be generated by using opaextractbadlinks or opaextractsellinks.
John Fleck's avatar
John Fleck committed
99 100 101 102 103 104 105 106
.SH Environment 
.NL

.PP
The following environment variables are also used by this command:
.TP 10
\fBPORTS\fR 
.NL
107 108
List of ports, used in absence of -t and -p.

John Fleck's avatar
John Fleck committed
109 110 111
.TP 10
\fBPORTS\(ulFILE\fR 
.NL
112 113
File containing list of ports, used in absence of -t and -p.

John Fleck's avatar
John Fleck committed
114 115
.SH Examples 
.NL
116 117 118
opadisableports \'bad cable\' < disable.csv
.br
opadisableports -p \'1:1 2:1\' \'dead servers\' < disable.csv