Blame IbaTools/man/opainfo.manPage

Packit 857059
.\" .\" *********************************************************************
Packit 857059
.\" .\" *                                                                   *
Packit 857059
.\" .\" *             Copyright 2015-2019, Intel Corporation                *
Packit 857059
.\" .\" *                                                                   *
Packit 857059
.\" .\" *                       All Rights Reserved.                        *
Packit 857059
.\" .\" *                                                                   *
Packit 857059
.\" .\" *********************************************************************
Packit 857059
Packit 857059
.TH opainfo 1 "Intel Corporation" "Copyright(C) 2015\-2019" "IFSFFCLIRG (Man Page)"
Packit 857059
.SH NAME
Packit 857059
opainfo
Packit 857059
Packit 857059
Packit 857059
.PP
Packit 857059
Provides summary information for local HFI port(s).
Packit 857059
.SH Syntax
Packit 857059
opainfo [-h  \fIhfi\fR] [-p  \fIport\fR] [-o  \fItype\fR] [-g] [-d  \fIdetail\fR]
Packit 857059
[-s pm\(ulsl]
Packit 857059
.br
Packit 857059
[-v [-v]...]
Packit 857059
Packit 857059
.SH Options
Packit 857059
Packit 857059
.TP 10
Packit 857059
--help
Packit 857059
Packit 857059
Produces full help text.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-h \fIhfi\fR
Packit 857059
Packit 857059
Specifies the HFI, numbered 1..n. Using 0 specifies that the -p \fIport\fR port is a system-wide port number. Default is 0.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-p \fIport\fR
Packit 857059
Packit 857059
Specifies the port, numbered 1 to n. Using 0 specifies the first active port across all HFIs/ports. Default is 1 which indicates all ports. If selected, the tool returns information on all available ports if p is not defined.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-o \fItype\fR
Packit 857059
Packit 857059
Specifies the output type and can appear more than once.
Packit 857059
Packit 857059
.TP 10
Packit 857059
.BR
Packit 857059
Packit 857059
.PP
Packit 857059
Packit 857059
.B NOTE:
Packit 857059
Behavior without -o gives a brief summary of portinfo, counters and cableinfo.
Packit 857059
Packit 857059
.RS
Packit 857059
.TP 10
Packit 857059
Packit 857059
.sp
Packit 857059
info
Packit 857059
Outputs detailed portinfo.
Packit 857059
.RE
Packit 857059
Packit 857059
.RS
Packit 857059
.TP 10
Packit 857059
Packit 857059
.sp
Packit 857059
stats
Packit 857059
Outputs detailed port counters.
Packit 857059
.RE
Packit 857059
Packit 857059
.TP 10
Packit 857059
-g
Packit 857059
Packit 857059
Output is displayed in line-by-line format. Default is summary format.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-d \fIdetail\fR
Packit 857059
Packit 857059
Output detail level. Range is 0 - 2. CableInfo only. Default is 0.
Packit 857059
Packit 857059
.TP 10
Packit 857059
.BR
Packit 857059
Packit 857059
.PP
Packit 857059
Packit 857059
.B NOTE:
Packit 857059
-d option is ignored when used with -o type.
Packit 857059
Packit 857059
.RS
Packit 857059
.TP 10
Packit 857059
Packit 857059
.sp
Packit 857059
0
Packit 857059
Minimal crucial information (for example, cable length, vendor)
Packit 857059
Packit 857059
.RE
Packit 857059
Packit 857059
.RS
Packit 857059
.TP 10
Packit 857059
Packit 857059
.sp
Packit 857059
1
Packit 857059
Brief summary
Packit 857059
Packit 857059
.RE
Packit 857059
Packit 857059
.RS
Packit 857059
.TP 10
Packit 857059
Packit 857059
.sp
Packit 857059
2
Packit 857059
Extended brief summary
Packit 857059
Packit 857059
.RE
Packit 857059
Packit 857059
.TP 10
Packit 857059
-s \fIpm\(ulsl\fR
Packit 857059
Packit 857059
Specifies different Service Level for PMA traffic.
Packit 857059
Packit 857059
Packit 857059
.SH -h and -p options permit a variety of selections:
Packit 857059
Packit 857059
.TP 10
Packit 857059
-h 0
Packit 857059
Packit 857059
First active port in system (Default).
Packit 857059
Packit 857059
.TP 10
Packit 857059
-h 0 -p 0
Packit 857059
Packit 857059
First active port in system.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-h \fIx\fR
Packit 857059
Packit 857059
First active port on HFI \fIx\fR.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-h \fIx\fR \fI\fR-p 0
Packit 857059
Packit 857059
First active port on HFI \fIx\fR.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-h 0 -p \fIy\fR
Packit 857059
Packit 857059
Port \fIy\fR within system (no matter which ports are active).
Packit 857059
Packit 857059
.TP 10
Packit 857059
-h \fIx\fR \fI\fR-p \fIy\fR
Packit 857059
Packit 857059
HFI \fIx\fR, port \fIy\fR.
Packit 857059
Packit 857059
Packit 857059
.SH Debug Options
Packit 857059
Packit 857059
.TP 10
Packit 857059
-v
Packit 857059
Packit 857059
Specifies the verbose output. Additional invocations (-v -v ...) turn on debugging, openib debugging, and libibumad debugging.
Packit 857059
Packit 857059
.SH Examples
Packit 857059
opainfo
Packit 857059
.br
Packit 857059
Packit 857059
  hfi1\(ul0:1 PortGID:0xfe80000000000000:001175010165b19c
Packit 857059
.br
Packit 857059
Packit 857059
  PortState:     Active
Packit 857059
.br
Packit 857059
Packit 857059
  LinkSpeed Act: 25Gb En: 25Gb
Packit 857059
.br
Packit 857059
Packit 857059
  LinkWidth Act: 4 En: 4
Packit 857059
.br
Packit 857059
Packit 857059
  LinkWidthDnGrd ActTx: 4 Rx: 4 En: 3,4
Packit 857059
.br
Packit 857059
Packit 857059
  LCRC Act: 14-bit En: 14-bit,16-bit,48-bit Mgmt: True
Packit 857059
.br
Packit 857059
Packit 857059
  LID: 0x00000001-0x00000001 SM LID: 0x00000002 SL: 0
Packit 857059
.br
Packit 857059
Packit 857059
  QSFP: PassiveCu, 1m FCI Electronics P/N 10131941-2010LF Rev 5
Packit 857059
.br
Packit 857059
Packit 857059
  Xmit Data:           22581581 MB Pkts:           5100825193
Packit 857059
.br
Packit 857059
Packit 857059
  Recv Data:           18725619 MB Pkts:           4024569756
Packit 857059
.br
Packit 857059
Packit 857059
  Link Quality: 5 (Excellent)