c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🎀 c8y(1) — bestie edition 🎀

okay so real talk, this is the man page for c8y-firmware-patches, part of the c8y manual. yes the title is literally just c8y(1) and the actual tool lives in the NAME section, that's just how man pages do. anyway, buckle up 💅

✨ NAME ✨

c8y-firmware-patches — Cumulocity firmware patch management 🌸

like, it's the firmware-patch-management part of the c8y CLI. that's the whole vibe.

🦋 SYNOPSIS 🦋

c8y firmware patches [flags]

that's it. that's the invocation. go off 👑

💖 DESCRIPTION 💖

Firmware patch management to create/list/delete patches ✨

so it's giving "I manage firmware patches" — creating them, listing them, deleting them. the full trio. no cap.

💅 OPTIONS 💅

  • -h, --help[=false] — help for patches. the classic "what does this even do" button 🫶

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

okay so these aren't even this command's own flags, they're inherited from the parent commands — the way that family recipes get passed down, except these are CLI flags. all of them. every single one. let's go 😭

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. so after that many errors it just stops trying, respectfully.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). be forgiving about empty pipes, king behavior.
  • --cache[=false] — Enable cached responses ✨
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. so [] means "hash everything", basically.
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. how long the cache stays iconic before it expires 💀
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. so on a terminal you get the pretty version unless you say otherwise.
  • --confirm[=false] — Prompt for confirmation 🙈
  • --confirmText="" — Custom confirmation text. make it say whatever you want, main character energy.
  • --currentPage=0 — Current page which should be returned.
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — Set very verbose log messages. it WILL overshare. that's the point.
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s
  • --dry[=false] — Dry run. Don't send any data to the server. literally just vibes, nothing actually happens 🔥
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl
  • --examples[=false] — Show examples for the current command. we love a demo.
  • --filter=[] — Apply a client side filter to response before returning it to the user.
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested → dotted, gorgeous.
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. so --confirm wins, always.
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — Include all results by iterating through each page. get everything, not just page one.
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. ⚠️ bestie, insecure is right there in the name, be careful.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!) ⚠️ like the man page literally says use with caution, so… caution.
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. read that twice ngl, it's a weird one.
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). it overrides the cache setting, periodt.
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. sad beige logs 😔
  • --noLog[=false] — Disables the activity log for the current command.
  • --noProgress[=false] — Disable progress bars.
  • --noProxy[=false] — Ignore the proxy settings.
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. saves you from the loop eating your stdin, iykyk.
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader
  • --outputFile="" — Save JSON output to file (after select/view)
  • --outputFileRaw="" — Save raw response to file (before select/view)
  • --outputTemplate="" — jsonnet template to apply to the output
  • -p, --pageSize=5 — Maximum results per page.
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. so it's a trade-off, bestie.
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. it overrides things, that's just the deal.
  • --retries=3 — Max number of attempts when a failed http call is encountered.
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
  • --session="" — Session configuration
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled.
  • -P, --sessionPassword="" — Override session password 🔐
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant)
  • --silentExit[=false] — Silent status codes do not affect the exit code.
  • --silentStatusCodes="" — Status codes which will not print out an error message. shhh 🤫
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m
  • --totalPages=0 — Total number of pages to get.
  • -v, --verbose[=false] — Verbose logging.
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off
  • --withError[=false] — Errors will be printed on stdout instead of stderr.
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13)
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages
  • --workers=1 — Number of workers.

🧚 SEE ALSO 🧚

go read these next, they're all linked and they all slay:

💀 fun fact: this page was dated Jan 1980. yes. 1980. before most of us were born. and it's from the c8y(1) manual. aging like fine wine, honestly 🍓

okay bye bestie, go patch some firmware, you're gonna do amazing 💜🫶✨

📦 where this page comes from