|
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 opaextractlids 8 "Intel Corporation" "Copyright(C) 2015\-2019" "IFSFFCLIRG (Man Page)"
|
|
Packit |
857059 |
.SH NAME
|
|
Packit |
857059 |
opaextractlids
|
|
Packit |
857059 |
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.PP
|
|
Packit |
857059 |
Produces a CSV file listing all or some of the LIDs in the fabric. opaextractlids is a front end to the opareport tool. The output from this tool can be imported into a spreadsheet or parsed by other scripts.
|
|
Packit |
857059 |
.SH Syntax
|
|
Packit |
857059 |
opaextractlids [opareport \fIoptions\fR]
|
|
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 |
opareport \fIoptions\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
The following options are passed to opareport. This subset is considered typical and useful for this command. By design, the tool ignores -o/--output report option.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.RS
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.sp
|
|
Packit |
857059 |
-h/--hfi \fIhfi\fR
|
|
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 |
.RE
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.RS
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.sp
|
|
Packit |
857059 |
-p/--port \fIport\fR
|
|
Packit |
857059 |
Specifies the port, numbered 1..n. Using 0 specifies the first active port. Default is 0.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.RE
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.RS
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.sp
|
|
Packit |
857059 |
-X/--infile \fIsnapshot\(ulinput\fR
|
|
Packit |
857059 |
Generates a report using the data in the snapshot\(ulinput file. snapshot\(ulinput must have been generated during a previous -o \fIsnapshot\fR run. When used, the -s, -i, -C, and -a options are ignored. \[aq]-\[aq] may be used as the snapshot\(ulinput to specify stdin.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.RE
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.RS
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.sp
|
|
Packit |
857059 |
-F/--focus \fIpoint\fR
|
|
Packit |
857059 |
Specifies the focus area for report. Used for all reports except route to limit scope of report. Refer to
|
|
Packit |
857059 |
\fIPoint Syntax\fR
|
|
Packit |
857059 |
for details.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.RE
|
|
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 Point Syntax
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
gid:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is numeric port GID of form: subnet:guid.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
lid:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is numeric LID.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
lid:value:node
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is numeric LID, selects entire node with given LID.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
lid:\fIvalue\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is numeric LID of node, \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
portguid:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is numeric port GUID.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodeguid:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is numeric node GUID.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodeguid:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is numeric node GUID, \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
iocguid:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is numeric IOC GUID.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
iocguid:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is numeric IOC GUID, \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
systemguid:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is numeric system image GUID.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
systemguid:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is the numeric system image GUID, \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
ioc:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is IOC Profile ID String (IOC Name).
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
ioc:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is IOC Profile ID String (IOC Name), \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
iocpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for IOC Profile ID String (IOC Name).
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
iocpat:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is glob pattern for IOC Profile ID String (IOC Name), \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
ioctype:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is IOC type (SRP or OTHER).
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
ioctype:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is IOC type (SRP or OTHER); \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
node:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is node description (node name).
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
node:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is node description (node name), \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodepat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for node description (node name).
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodepat:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is the glob pattern for the node description (node name), \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodedetpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for node details.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodedetpat:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is the glob pattern for the node details, \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodetype:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is node type (SW or FI).
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodetype:\fIvalue1\fR:port:\fIvalue2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue1\fR is node type (SW or FI), \fIvalue2\fR is port number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
rate:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is string for rate (25g, 50g, 75g, 100g), omits switch mgmt port 0.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
portstate:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is a string for state (down, init, armed, active, notactive, initarmed).
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
portphysstate:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is a string for PHYs state (polling, disabled, training, linkup, recovery, offline, test)
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
mtucap:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is MTU size (2048, 4096, 8192, 10240), omits switch mgmt port 0.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
labelpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for cable label.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
lengthpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for cable length.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
cabledetpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for cable details.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
cabinflenpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for cable info length.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
cabinfvendnamepat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for cable info vendor name.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
cabinfvendpnpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for cable info vendor part number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
cabinfvendrevpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for cable info vendor revision.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
cabinfvendsnpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for cable info vendor serial number.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
cabinftype:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is either optical, passive\(ulcopper, active\(ulcopper, or unknown.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
linkdetpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for link details.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
portdetpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for port details.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
sm
|
|
Packit |
857059 |
|
|
Packit |
857059 |
Specifies the master subnet manager (SM).
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
smdetpat:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is glob pattern for SM details.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
route:\fIpoint1\fR:\fIpoint2\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
Specifies all ports along the routes between the two given points.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
led:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
\fIvalue\fR is either on or off for LED port beacon.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
linkqual:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
Specifies the ports with a link quality equal to \fIvalue\fR.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
linkqualLE:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
Specifies the ports with a link quality less than or equal to \fIvalue\fR.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
linkqualGE:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
Specifies the ports with a link quality greater than or equal to \fIvalue\fR.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodepatfile:\fIFILENAME\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
Specifies the name of file with the list of nodepats or node descriptions.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
nodepairpatfile:\fIFILENAME\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
Specifies the name of file with the list of node pairs, separated by a colon.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
ldr
|
|
Packit |
857059 |
|
|
Packit |
857059 |
Specifies the ports with a non-zero link down reason or neighbor link down reason.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.TP 10
|
|
Packit |
857059 |
ldr:\fIvalue\fR
|
|
Packit |
857059 |
|
|
Packit |
857059 |
Specifies the ports with a link down reason or neighbor link down reason equal to \fIvalue\fR.
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.SH Examples
|
|
Packit |
857059 |
# List all the lids in the fabric:
|
|
Packit |
857059 |
.br
|
|
Packit |
857059 |
|
|
Packit |
857059 |
opaextractlids
|
|
Packit |
857059 |
.br
|
|
Packit |
857059 |
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.br
|
|
Packit |
857059 |
|
|
Packit |
857059 |
# List all the lids of end-nodes:
|
|
Packit |
857059 |
.br
|
|
Packit |
857059 |
|
|
Packit |
857059 |
opaextractlids -F "nodetype:FI"
|
|
Packit |
857059 |
.br
|
|
Packit |
857059 |
|
|
Packit |
857059 |
|
|
Packit |
857059 |
.br
|
|
Packit |
857059 |
|
|
Packit |
857059 |
# List all the lids on the 2nd HFI\[aq]s fabric of a multi-plane fabric:
|
|
Packit |
857059 |
.br
|
|
Packit |
857059 |
|
|
Packit |
857059 |
opaextractlids -h 2
|