c8y(1)

📦 version 2.56.1, in nixpkgs unstable

c8y(1) — get that firmware patch bestie 💅

okay so this is the c8y manual page (section 1 of the man pages, iykyk), and specifically it's all about c8y-firmware-patches-get. yes the header says c8y(1), no we're not confused, it's the same family. sit down, grab a lil snack, we're reading a manpage together 🍓

✨ NAME ✨

c8y-firmware-patches-get — literally just: get firmware patch. that's the whole vibe. 🌸

🦋 SYNOPSIS 🦋

c8y firmware patches get [flags]

that's it. that's the incantation. flags optional but like, the good ones are in OPTIONS below 👑

💖 DESCRIPTION 💖

Get an existing firmware patch.

(short and iconic, no notes, periodt. it fetches a firmware patch that already exists. no cap.) 🎀

👑 OPTIONS 👑

  • --firmware=[] — the firmware package id or name. lowkey this one exists mostly so tab-completion can be more accurate, which is a slay of a reason honestly 🫶
  • -h, --help[=false] — help for get. the classic. the icon.
  • --id=[] — firmware patch id or name. required bestie, do not forget it. also accepts pipeline, which is very main character of it 💅
  • --skipChildrenNames[=false] — don't include the child devices' names in the response. the glow-up here is that the API response can improve bc the names don't need to be retrieved ✨
  • --withChildren[=false] — decides whether children with ID and name get returned when fetching the managed object. set it to false if you want better query performance (trading info for speed, classic)
  • --withChildrenCount[=false] — when set to true, the returned result contains the total number of children in the respective objects: childAdditions, childAssets and childDevices 🧚
  • --withGroups[=false] — when set to true it returns extra info about the groups the searched managed object belongs to. this results in setting the assetParents property with additional info about the groups 🌈
  • --withParents[=true] — include a flat list of all parents and grandparents of the given object. yes, the whole family tree. and note it defaults to true, she's on by default 💀

🌟 OPTIONS INHERITED FROM PARENT COMMANDS 🌟

these aren't hers, she's just borrowing them from her parents. still every single one matters 🔥

  • --abortOnErrors=10 — abort the batch when it reaches the specified number of errors
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). she's forgiving like that 🙈
  • --cache[=false] — enable cached responses
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty means all values
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal
  • --confirm[=false] — prompt for confirmation
  • --confirmText="" — custom confirmation text
  • --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 (she's a yapper)
  • --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. she's just practicing 🎀
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl
  • --examples[=false] — show examples for the current command
  • --filter=[] — apply a client side filter to the 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
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm (they do NOT stack, ok)
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — include all results by iterating through each page
  • -k, --insecure[=false] — allow insecure server connections when using SSL (yes it's called insecure, yes that's a whole warning, proceed with intention)
  • -l, --logMessage="" — add custom message to the activity log
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution! fr fr, this is not a drill) 🔥
  • --noAccept[=false] — ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting)
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console
  • --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
  • -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 (she can't multitask, and that's fine)
  • --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
  • --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
  • --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

🎀 EXAMPLE 🎀

like this, bestie:

$ c8y firmware patches get --firmware 11111 --id 1.0.0
Get a firmware patch

look at her go. ate and left no crumbs ⭐

🌈 SEE ALSO 🌈

okay that's the page!! source + version + date business: this one's from Jan 1980, filed under c8y(1) — yes the date is ancient, she's vintage, she's an heirloom, don't come for her 💜 mwah, go get that patch 🫶✨

📦 where this page comes from