SALT-PEPPER(1)

📦
version 0.5.5 · 3 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

✨ SALT-PEPPER(1) ✨

okay bestie, pull up a chair 🫶 this is the salt-pepper manual page — it lives in the User Commands section, and it's your lil backstage pass to a remote salt-api instance. let's get into it 💅

🌸 NAME 🌸

salt-pepper — the tool you use to access a salt-api instance ✨

🎀 SYNOPSIS 🎀

salt-pepper [opts]

🦋 DESCRIPTION 🦋

it's a CLI interface to a remote salt-api instance. that's the whole vibe. you talk, salt listens 💖

👑 OPTIONS 👑

  • --version — show the program's version number and then dip out. bye 👋
  • -h, --help — show this help message and exit. the classic.
  • -c CONFIG — where your config file lives. the default is a file path that's sitting in the PEPPERRC environment variable, or else ~/.pepperrc. 🍓
  • -v — bump up output verbosity. you can stack this one multiple times if you're feeling extra 👀
  • -H, --debug-http — dumps the HTTP request/response headers out on stderr. great for snooping fr fr 🔍
  • --ignore-ssl-errors — ignore any SSL certificate that may be encountered.
⚠️ ngl bestie, it is recommended to resolve certificate errors for production. don't be out here ignoring certs in prod, that's not the move 💀

Pepper salt Options:

Mimic the salt CLI 💫

  • -t TIMEOUT, --timeout=TIMEOUT — how long to wait (in seconds) before handing control back to your shell. patience is a virtue but also a config value ⏳
  • --client=CLIENT — pick which salt-api client to use (local, local_async, runner, etc). choose your fighter 🥊
  • --json=JSON_INPUT — type JSON straight at the CLI instead of using positional (text) arguments. this is so useful when your args need complex data structures. heads up tho: specifying this argument makes your positional arguments get ignored entirely. so like. pick one 😭
  • --json-file=JSON_FILE — point at a file containing the JSON that salt-pepper should use 📂
  • --fail-if-incomplete — returns a failure exit code if not all minions respond. this option requires that the authenticated user has access to run the jobs.list_jobs runner function. no access, no dice 🎲

Targeting Options:

Target which minions to run commands on 🎯

  • -E, --pcre — target hostnames using PCRE regular expressions. regex girlies rise 🙌
  • -L, --list — specify a comma delimited list of hostnames ✍️
  • -G, --grain — target based on system properties 🌾
  • --grain-pcre — target based on PCRE matches on system properties 🔎
  • -I, --pillar — target based on pillar values 🏛️
  • --pillar-pcre — target based on PCRE matches on pillar values 🔍
  • -R, --range — target based on a range expression 📏
  • -C, --compound — target based on a compound expression 🧪
  • -N, --nodegroup — target based on a named nodegroup 👯
  • --batch=BATCH — (the original page leaves this one blank bestie, so we leave it blank too. mysterious. iconic. main character energy honestly 💅)

Authentication Options:

Authentication credentials can optionally be supplied via these environment variables: SALTAPI_URL, SALTAPI_USER, SALTAPI_PASS, SALTAPI_EAUTH. env vars doing the most, as always 🌈

  • -u SALTAPIURL, --saltapi-url=SALTAPIURL — specify the host url. defaults to https://localhost:8080 🏠
  • -a EAUTH, --auth=EAUTH, --eauth=EAUTH, --extended-auth=EAUTH — specify the external_auth backend to authenticate against, and it'll interactively prompt you for credentials. four whole names for one option, she contains multitudes ✨
  • --username=USERNAME — optional, defaults to user name. it'll be prompted if empty, unless you passed --non-interactive 🙈
  • --password=PASSWORD — optional, but it will be prompted unless --noninteractive 👀
💀 yes bestie, the original page really does spell it --noninteractive here and --non-interactive up above. we don't fix it, we respect it. copy the spelling exactly or you'll be sad.
  • --token-expire=TOKEN_EXPIRE — set eauth token expiry in seconds. must be allowed per user. see the token_expire_user_override Master setting for more info. permission check first, always 🔐
  • --non-interactive — optional. fail rather than waiting for input. no waiting around, we're busy 🏃♀️
  • -T, --make-token — generate and save an authentication token for re-use. the token is generated and made available for the period defined in the Salt Master. set it and forget it (until the Master says otherwise) 🎟️
  • -r, --run-uri — use an eauth token from /token and send commands through the /run URL instead of the traditional session token approach. different route, same destination 🛣️
  • -x CACHE — cache file location. default is a file path in the PEPPERCACHE environment variable, or ~/.peppercache. 🗂️

💜 SEE ALSO 💜

the full documentation for salt-pepper is maintained as a Texinfo manual. if the info and salt-pepper programs are properly installed at your site, then this command:

info salt-pepper

should give you access to the complete manual. go read, bestie, it's giving educated 📚✨

that's the whole page!! this is salt-pepper 0.5.5-1, dated March 2018 🎀 slay, mwah, go pepper some salt 🫶💖

📦 where this page comes from