opacapture.manPage 3.05 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 opacapture 1 "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 18
.SH NAME
opacapture

.NL

.PP

\fB(Host)\fR
Captures critical system information into a zipped tar file. The resulting tar file should be sent to Customer Support along with any Intel(R) Omni-Path Fabric problem report regarding this system.
19 20 21 22 23 24
.PP

.B NOTE:
The resulting host capture file can require significant amounts of space on the host. The actual size varies, but sizes can be multiple megabytes. Intel recommends ensuring that adequate disk space is available on the host system.


John Fleck's avatar
John Fleck committed
25 26
.SH Syntax
.NL
27
opacapture [-d \fIdetail\fR] \fIoutput\(ultgz\(ulfile\fR
John Fleck's avatar
John Fleck committed
28 29 30 31 32 33 34 35 36 37
.PP
or
.br
opacapture --help
.SH Options
.NL

.TP 10
--help 
.NL
38
Shows full help text.
John Fleck's avatar
John Fleck committed
39 40 41 42

.TP 10
-d \fIdetail\fR 
.NL
43 44 45 46
Captures level of detail:
.RS
.TP 10

John Fleck's avatar
John Fleck committed
47 48
.sp
1 (Local)
49 50 51 52 53 54 55
Obtains local information from host. Default if no options are entered.

.RE

.RS
.TP 10

John Fleck's avatar
John Fleck committed
56 57
.sp
2 (Fabric)
58 59 60 61 62 63 64
In addition to \fILocal\fR, also obtains basic fabric information by queries to the SM and fabric error analysis using \fBopareport\fR.

.RE

.RS
.TP 10

John Fleck's avatar
John Fleck committed
65 66
.sp
3 (Fabric+FDB)
67 68 69 70 71 72 73
In addition to \fIFabric\fR, also obtains the Forwarding Database (FDB), which includes the switch forwarding tables from the SM and the server multicast membership.

.RE

.RS
.TP 10

John Fleck's avatar
John Fleck committed
74 75
.sp
4 (Analysis)
76 77 78 79 80
In addition to \fIFabric+FDB\fR, also obtains opaallanalysis results. If opaallanalysis has not yet been run, it is run as part of the capture.

.RE


John Fleck's avatar
John Fleck committed
81 82 83 84 85 86
.TP 10
.BR

.PP

.B NOTE:
87
Detail levels 2 - 4 can be used when fabric operational problems occur. If the problem is node-specific, detail level 1 should be sufficient. Detail levels 2 - 4 require an operational Fabric Manager. Typically your support representative requests a given detail level. If a given detail level takes excessively long or fails to be gathered, try a lower detail level.
John Fleck's avatar
John Fleck committed
88 89 90 91 92

.PP
For detail levels 2 - 4, the additional information is only available on a node with Intel(R) Omni-Path Fabric Suite FastFabric Toolset installed. The information is gathered for every fabric specified in the /etc/sysconfig/opa/ports file.

.TP 10
93
 \fIoutput\(ultgz\(ulfile\fR 
John Fleck's avatar
John Fleck committed
94
.NL
95 96
The name of a file to be created by opacapture. The file name specified is overwritten if it already exists. Intel recommends using the .tgz suffix in the file name supplied. If the filename given does not have a .tgz suffix, the .tgz suffix is added.

John Fleck's avatar
John Fleck committed
97 98
.SH Examples 
.NL
99
opacapture mycapture.tgz
John Fleck's avatar
John Fleck committed
100
.br
101
opacapture -d 3 030127capture.tgz