ethcaptureall(8)

💖 ethcaptureall(8) 💖

EFSFFCLIRG man page energy, bestie. Buckle up, we're grabbing ALL the receipts. 🧾✨

---

🌸 NAME 🌸

ethcaptureall — grabs supporting info for a problem report from every single host and uploads it all back to this system. Like a group project where everyone actually submits their part. Iconic. 💅

So here's the tea: when a host ethcaptureall happens, ethcapture runs and creates the capture file you asked for inside ~root on each host (with .tgz tacked on as needed, no cap). Those files get uploaded and unpacked into a matching directory name inside upload_dir/hostname/ on your local system. The default file name is hostcapture.

Then — and this is the slay part — all the uploaded captures get combined into one .tgz file, using the file name you specified, with the suffix .all.tgz added. Chef's kiss. 🎀

---

✨ Syntax ✨

ethcaptureall [-p] [-f  hostfile] [-h 'hosts'] [-d  upload_dir]

[-D  detail_level] [ file]

---

🦋 Options 🦋

• --help — spits out the full help text. Ask and you shall receive, queen. 👑
• -p — does the capture upload in parallel on all hosts. Everything everywhere all at once, but make it cluster ops.
• -f hostfile — points at the file with the hosts in the cluster. Default is the /etc/eth-tools/hosts file.
• -h hosts — hands over the list of hosts to capture. Just give it the names.
• -d upload_dir — the directory to upload to. Default is uploads. And if you don't specify it at all? It falls back to the environment variable UPLOADS_DIR. She has a backup plan, obviously. 🫶
• -D detail_level — sets how much detail the capture has, and this gets passed to the local host ethcapture.
  1. 1 (Local) — obtains local information from each host.
  2. 2 (Fabric) — on top of Local, also obtains basic fabric information using ethreport.
  3. 3 (Analysis) — on top of Fabric, also obtains ethallanalysis results. And if ethallanalysis hasn't been run yet? It gets run as part of the capture. No skipping ahead, bestie.

NOTE: 📝 - Detail levels 2-3 can be used when fabric operational problems occur. If the problem is node-specific, detail level 1 should be sufficient. Detail levels 2-3 require an operational fabric. 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. (Lowering the bar is valid here, fr fr.) - For detail levels 2-3, the additional information is only gathered on the node running the ethcaptureall command. Just the one node, main character only. 👑

• file — the name for the capture file. And if your specified name doesn't end in .tgz? The suffix .tgz gets appended. It's giving "we'll finish your sentence for you." 😭

---

🌈 Examples 🌈

ethcaptureall

# Creates a hostcapture directory in upload_dir/hostname/ for each host
# in /etc/eth-tools/hosts file, then creates hostcapture.all.tgz.

---

ethcaptureall mycapture

# Creates a mycapture directory in upload_dir/hostname/ for each host
# in /etc/eth-tools/hosts file, then creates mycapture.all.tgz.

---

ethcaptureall -h 'arwen elrond' 030127capture

# Gets the list of hosts from arwen elrond file and creates
# 030127capture.tgz file.

---

💜 Environment Variables 💜

These little cuties are also used by this command:

• HOSTS — list of hosts, used if the -h option isn't supplied.
• HOSTS_FILE — file containing a list of hosts, used in the absence of -f and -h.
• UPLOADS_DIR — directory to upload to, used in the absence of -d.
• FF_MAX_PARALLEL — when the -p option is used, the maximum concurrent operations that get performed.

---

🎀 More Information 🎀

When you're performing ethcaptureall against hosts, SSH is used internally. So the ethcaptureall command requires that password-less SSH be set up between the host running Intel(R) Ethernet Fabric Suite FastFabric Toolset and the hosts that ethcaptureall is operating against. The ethsetupssh command can aid in setting up password-less SSH — go say hi to it, it's helpful. 🧚

NOTE: The resulting host capture files can require significant amounts of space on the Intel(R) Ethernet Fabric Suite FastFabric Toolset host. Actual size varies, but sizes can be multiple megabytes per host. Intel recommends that you ensure adequate space is available on the Intel(R) Ethernet Fabric Suite FastFabric Toolset system. In many cases, it may not be necessary to run ethcaptureall against all hosts; instead, a representative subset may be sufficient. Consult with your support representative for further information. 💀 (Disk space is not a vibe you want to run out of.)

---

And that's the whole page, bestie! 💖 This was ethcaptureall(8) from the EFSFFCLIRG man page, copyright Copyright(C) 2020-2024 Intel Corporation. Go forth, capture everything, and remember: password-less SSH first, questions later. Mwah! 🫶✨💅