insights-client(8)

📦 version 3.10.5, in centos-stream 10

💖 insights-client(8) — the Red Hat Insights Client tool, but make it make sense 💖

hey bestie!! so you're looking at insights-client(8), the man page for the Red Hat Insights Client tool. don't worry, i got you. we're gonna go through this together and you're gonna understand every bit of it, fr fr. 🫶

🦋 SYNOPSIS 🦋

okay so the whole vibe is just:

insights-client [options]

that's it. that's the shape of it. options go in, magic happens. periodt. ✨

🌸 DESCRIPTION 🌸

insights-client is literally designed to help customers proactively resolve issues that are messing with business operations in Red Hat Enterprise Linux and Red Hat Cloud Infrastructure environments. like, it's out here catching problems before they become a whole thing.

you can view alerts or learn more at https://console.redhat.com/insights/. 👑

now bestie, real talk: this app is dynamic, which means some options may pop up that aren't even described in this manual. no cap. so please refer to the output of --help for the most up-to-date options, or check out https://access.redhat.com/articles/4099591 for more details. iykyk. 💅

💅 OPTIONS 💅

get comfy, because there are a lot of these and each one is iconic in its own way:

  • -h, --help — shows this help message and then dips. classic. ✨
  • --register — registers the host to the Red Hat Insights service. welcome to the club, bestie 🎀
  • --unregister — unregisters the host. it's giving "it's not me, it's you" energy 🙈
  • --display-name=DISPLAYNAME — the display name to use for this host. may be used during registration. give it a cute name, you deserve it 💖
  • --group=GROUP — adds a tag name group with the specified value to this host. the tag gets saved to the tags file. very organized of you 🌸
  • --retry=RETRIES — number of times to retry uploading. and just so you know, there are 180 seconds between tries. patience is a virtue bestie 😭
  • --validate — validates the contents of the denylist configuration. checking its vibe, essentially ✅
  • --quiet — only displays error messages to stdout. minimal queen behavior 👑
  • --silent — displays no messages to stdout. respectfully, silence. 💀
  • --enable-schedule — enables automatic scheduling. let it run itself, you're busy 🌈
  • --disable-schedule — disables automatic scheduling. sometimes you need a break, and that's okay 🫶
  • --compressor — specifies the compression algorithm to use. choices are gz, bz2, xz, and none. defaults to gz. pick your fighter 🥊
  • --offline — collects locally only, does not connect to Insights and does not upload. introvert mode activated 🧚
  • --payload=FILE — skips collection and uploads a specified archive. requires --content-type though, don't forget that part 🚨
  • --content-type=TYPE — the content type of the archive specified with --payload. gotta label it properly, bestie 🎀
  • --diagnosis — retrieves a diagnosis for this host. getting to the root of the matter 🔍
  • --compliance — scans the system with OpenSCAP and uploads the report. very thorough, very slay ✨
  • --check-results — retrieves analysis results from the Red Hat Insights service. the receipts!! 🧾
  • --show-results — displays analysis results from the Red Hat Insights service. show and tell time 👀
  • --output-dir=DIR — writes the collection to a specified directory. does not perform an upload. local only, keeping it close 💜
  • --output-file=FILE — writes the collection to a specified file. also does not perform an upload. same energy, different destination 🦋
  • --checkin — performs a lightweight hourly check-in. just saying hi, keeping the streak alive ⭐
  • --list-specs — shows insights-client collection specs. the full menu, if you will 🍓
  • --compliance — runs a Compliance scan and upload. yes it's listed again, and yes it's still iconic 👑 (this is how the original rolls, we don't question it)
  • --module MODULE, -m MODULE — runs a module from within the insights.client package. analogous to python -m MODULE. use only as directed — don't get creative with it, bestie 🙏

🔥 DEBUG OPTIONS 🔥

these are the behind-the-scenes ones. the vip access. the "i know a guy" options. use them wisely:

  • --version — displays version. gotta know what you're working with 💅
  • --test-connection — tests connectivity to Red Hat. can we reach them? let's find out 📡
  • --verbose — DEBUG output to stdout. all the tea, spilled ☕
  • --no-upload — does not upload the archive. keeping it on the low 🫣
  • --keep-archive — does not delete the archive after upload. you're a collector, i respect it 🎀
  • --support — creates a support logfile for Red Hat Insights. for when you need backup 🧚
  • --status — checks this host's registration status by checking the presence of /etc/insights-client/.registered file. the file is literally the proof, no cap ✅
  • --net-debug — logs network activity to console. watching the wires like it's a reality show 👀

🎀 MOTD 🎀

okay so here's the deal: a message will be displayed on login about insights-client if it's installed but hasn't been used at least once yet. it's like a little nudge. a "hey bestie, i'm here" moment 💌

wanna change this message? edit the /etc/insights-client/insights-client.motd file. make it say whatever you want, it's your world 🌈

and if you want to prevent this message from being shown on login? create the /etc/motd.d/insights-client symlink pointing to /dev/null. poof, gone. iconic 🫶

✨ LOGGING ✨

insights-client utilizes the 'logrotate' tool to rotate log files. very responsible, very organized 💅

to change log rotation options, edit the /etc/logrotate.d/insights-client file. please refer to the 'logrotate' tool documentation to see all available configuration options. i'm not gonna gatekeep, go read up 🎀

💜 SEE ALSO 💜

and that's the whole thing!! you did it, you read the whole man page, and honestly? i'm so proud of you. this was insights-client(8) from Red Hat Insights, and you absolutely ate. no crumbs. 💖✨🎀

go forth and be insightful, bestie. ily. 🫶👑

📦 where this page comes from