1
2ethcaptureall(8)             EFSFFCLIRG (Man Page)            ethcaptureall(8)
3
4
5

NAME

7       ethcaptureall
8
9
10
11       Captures supporting information for a problem report from all hosts and
12       uploads to this system.
13
14       When a host ethcaptureall is performed, ethcapture is run to create the
15       specified  capture file within ~root on each host (with the .tgz suffix
16       added as needed). The files are uploaded and unpacked into  a  matching
17       directory name within upload_dir/hostname/ on the local system. The de‐
18       fault file name is hostcapture.
19
20       The uploaded captures are combined into a .tgz file with the file  name
21       specified and the suffix .all.tgz added.
22

Syntax

24       ethcaptureall [-p] [-f  hostfile] [-h 'hosts'] [-d  upload_dir]
25
26       [-D  detail_level] [ file]
27

Options

29       --help
30
31                 Produces full help text.
32
33
34       -p
35
36                 Performs capture upload in parallel on all hosts.
37
38
39       -f hostfile
40
41                 Specifies   the  file  with  hosts  in  cluster.  Default  is
42                 /etc/eth-tools/hosts file.
43
44
45       -h hosts
46
47                 Specifies the list of hosts on which to perform a capture.
48
49
50       -d upload_dir
51
52                 Specifies the directory to upload to. Default is uploads.  If
53                 not specified, the environment variable UPLOADS_DIR is used.
54
55
56       -D detail_level
57
58                 Specifies  the  level of detail of the capture passed to host
59                 ethcapture.
60
61
62
63                 1 (Local) Obtains local information from each host.
64
65
66
67
68                 2 (Fabric)
69                           In addition to Local, also obtains basic fabric in‐
70                           formation by queries to the fabric and fabric error
71                           analysis using ethreport.
72
73
74
75
76
77                 3 (Analysis)
78                           In addition to Fabric, also obtains  ethallanalysis
79                           results. If ethallanalysis has not yet been run, it
80                           is run as part of the capture.
81
82
83
84
85
86
87
88       NOTE: Detail levels 2-3 can be used when  fabric  operational  problems
89       occur. If the problem is node-specific, detail level 1 should be suffi‐
90       cient. Detail levels 2-3 require an operational fabric. Typically, your
91       support representative requests a given detail level. If a given detail
92       level takes excessively long or fails to be gathered, try a  lower  de‐
93       tail  level.For  detail  levels 2-3, the additional information is only
94       gathered on the node running the ethcaptureall command.
95
96
97
98       file
99
100                 Specifies the name for capture file. The suffix .tgz  is  ap‐
101                 pended if it is not specified in the name.
102
103

Examples

105       ethcaptureall
106
107       # Creates a hostcapture directory in upload_dir/hostname/ for each host
108       in /etc/eth-tools/hosts file, then creates hostcapture.all.tgz.
109
110
111
112       ethcaptureall mycapture
113
114       # Creates a mycapture directory in upload_dir/hostname/ for each host
115       in /etc/eth-tools/hosts file, then creates mycapture.all.tgz.
116
117
118
119       ethcaptureall -h 'arwen elrond' 030127capture
120
121       # Gets the list of hosts from arwen elrond file and creates
122       030127capture.tgz file.
123
124

Environment Variables

126       The following environment variables are also used by this command:
127
128       HOSTS
129
130                 List of hosts, used if -h option not supplied.
131
132
133       HOSTS_FILE
134
135                 File  containing  a  list of hosts, used in the absence of -f
136                 and -h.
137
138
139       UPLOADS_DIR
140
141                 Directory to upload to, used in the absence of -d.
142
143
144       FF_MAX_PARALLEL
145
146                 When -p option is used,  maximum  concurrent  operations  are
147                 performed.
148
149

More Information

151       When  performing  ethcaptureall  against hosts, internally SSH is used.
152       The command ethcaptureall requires that password-less SSH be set up be‐
153       tween  the  host  running  Intel(R)  Ethernet  Fabric  Suite FastFabric
154       Toolset and the hosts ethcaptureall is operating  against.  The  ethse‐
155       tupssh command can aid in setting up password-less SSH.
156
157       NOTE:  The resulting host capture files can require significant amounts
158       of space on the Intel(R) Ethernet Fabric Suite FastFabric Toolset host.
159       Actual size varies, but sizes can be multiple megabytes per host. Intel
160       recommends that you ensure adequate space is available on the  Intel(R)
161       Ethernet  Fabric Suite FastFabric Toolset system. In many cases, it may
162       not be necessary to run ethcaptureall against  all  hosts;  instead,  a
163       representative subset may be sufficient. Consult with your support rep‐
164       resentative for further information.
165
166
167
168Copyright(C) 2020              Intel Corporation              ethcaptureall(8)
Impressum