c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the firmware-get glow-up you didn't know you needed ✨

okay so bestie, this is the c8y manual page (section 1 of the manual, iykyk) and specifically it's all about c8y-firmware-get — yes, the firmware-getter herself. she's a subcommand of the c8y firmware family, and she's honestly iconic for what she does. let's get into it 🫶

🌸 NAME 🌸

c8y-firmware-get — Get firmware

that's it, that's her whole job. she gets firmware. main character energy fr 💅

🎀 SYNOPSIS 🎀

c8y firmware get [flags]

like, that's the whole invocation. you type it, you get firmware. slay ✨

🦋 DESCRIPTION 🦋

okay so what this literally does: it gets an existing firmware package, which is a managedObject. that's the vibe — you already have a firmware package sitting there on the tenant, and this command goes and fetches it for you. no cap, that's the entire description, she's a simple girlie 🍓

✨ OPTIONS ✨

here's the full flag lineup, bestie. every single one. no skipping 🙈

  • -h, --help[=false] — shows help for get. the classic. when in doubt, ask for help 💖
  • --id=[] — the firmware package (managedObject) id. this one is required — like, you cannot skip it, it's giving non-negotiable. also accepts pipeline input, so you can pipe that id right in there 🫶
  • --skipChildrenNames[=false] — "don't include the child devices names in the response." why would you want this? because the API response gets faster when it doesn't have to go retrieve all those names. performance queen behavior 💅
  • --withChildren[=false] — determines if children with ID and name should be returned when fetching the managed object. set it to false to improve query performance. your call, bestie ✨
  • --withChildrenCount[=false] — when set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices). counting the children, very mother-hen of her 🐣
  • --withGroups[=false] — when set to true it returns additional information about the groups the searched managed object belongs to. this results in setting the assetParents property with extra group info. she's telling you what circles she runs in 👑
  • --withParents[=false] — include a flat list of all parents and grandparents of the given object. the whole family tree, flat-laid out 🌳

🔥 OPTIONS INHERITED FROM PARENT COMMANDS 🔥

these come from the parent commands, so they're not exclusively hers, but they still show up and they all matter. let's go. ⭐

  • --abortOnErrors=10 — abort batch when reaching the specified number of errors. like, ten strikes and you're out 💀
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). she'll just vibe with the silence 🙈
  • --cache[=false] — enable cached responses. saving you that round trip ✨
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty indicates all values. very "specifics only" of her 🎀
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. clock's ticking bestie ⏰
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal. so it's already cute by default, this just makes it ✨less✨ 🦋
  • --confirm[=false] — prompt for confirmation. consent checks, we love to see it 🫶
  • --confirmText="" — custom confirmation text. your own words for the "u sure?" moment 💬
  • --currentPage=0 — current page which should be returned. page zero, the beginning of the journey 📖
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. you do you 🔥
  • --debug[=false] — set very verbose log messages. the "she's telling you EVERYTHING" mode 💀
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. pace yourself queen 🌸
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. breathe first 🧘
  • --dry[=false] — dry run. don't send any data to the server. practice mode, nothing leaves the group chat 🙈
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl. pick your aesthetic 💅
  • --examples[=false] — show examples for the current command. honestly? use this 👑 (okay, mild editorializing from me there — the flag does what it says, showing examples for the current command 💖)
  • --filter=[] — apply a client side filter to response before returning it to the user. you know exactly what you want 🎯
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested? not anymore. flat like a pancake 🥞
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. (so --confirm wins the argument, noted 📝)
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". headers on headers 💌
  • --includeAll[=false] — include all results by iterating through each page. all of it. every last one. obsessed 🌈
  • -k, --insecure[=false] — allow insecure server connections when using SSL. ⚠️ heads up bestie, this is the "I know what I'm doing" button, use accordingly ⚠️
  • -l, --logMessage="" — add custom message to the activity log. leave a little note for the timeline 📝
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). use with caution is literally in the docs so I'm passing it along fr fr 💀
  • --noAccept[=false] — ignore Accept header, will remove the Accept header from requests. however PUT and POST requests will only see the effect. important nuance, don't forget it 🎀
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). cold take, no stale vibes 🧊
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome era 🖤
  • --noLog[=false] — disables the activity log for the current command. off the record 🤫
  • --noProgress[=false] — disable progress bars. no little loading guys 🫠
  • --noProxy[=false] — ignore the proxy settings. straight to the source 🚀
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. very "I'm busy, don't pipe me" 🙅
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader. pick your presentation bestie 🎁
  • --outputFile="" — save JSON output to file (after select/view). post-processing save 💾
  • --outputFileRaw="" — save raw response to file (before select/view). pre-processing save, the raw truth 💾
  • --outputTemplate="" — jsonnet template to apply to the output. fancy ✨
  • -p, --pageSize=5 — maximum results per page. five at a time, cozy 🍵
  • --progress[=false] — show progress bar. this will also disable any other verbose output. (trade-off, noted 📝)
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. route it through 🛣️
  • -r, --raw[=false] — show raw response. this mode will force output=json and view=off. no filter, no vibes, just data 💀
  • --retries=3 — max number of attempts when a failed http call is encountered. three strikes, but for network glitches 🎳
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. cherry-picking, we stan 🍒
  • --session="" — session configuration. 🔑
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. one-time override, very rebellious 💅
  • -P, --sessionPassword="" — override session password. 🤫
  • -U, --sessionUsername="" — override session username. i.e. peter or t1234/peter (with tenant). tenant-aware, periodt 🏢
  • --silentExit[=false] — silent status codes do not affect the exit code. quiet quitting the exit code 😌
  • --silentStatusCodes="" — status codes which will not print out an error message. shhh 🤐
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. ten minutes default, generous queen ⏳
  • --totalPages=0 — total number of pages to get. how many pages, your choice 📚
  • -v, --verbose[=false] — verbose logging. she's chatty now 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable using --view off. auto is the default, she reads the room 👀
  • --withError[=false] — errors will be printed on stdout instead of stderr. redirect-friendly 🎯
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). version note, don't forget it 📌
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. 📄
  • --workers=1 — number of workers. one worker, chill pace 👷

🌈 EXAMPLE 🌈

$ c8y firmware get --id 12345
Get a firmware package

get a firmware package, directly by id. straightforward, gorgeous ✨

$ echo 12345 | c8y firmware get
Get a firmware package (using pipeline)

and the pipeline version — pipe the id straight in, she picks it up like the icon she is 💖 (this is why --id says it accepts pipeline, iykyk 🫶)

💜 SEE ALSO 💜

  • c8y-firmware(1) — her parent, the whole firmware family. go say hi 🦋

okay bestie that's the whole page!! every flag, every default, every little detail — nothing dropped, nothing invented, just delivered with the energy she deserves 👑

sign-off time 🌸 this beauty is dated Jan 1980 (yes, that date, iconic vintage energy) and lives under the manual name c8y in section 1 — so when you run man 1 c8y you know exactly whose page you're reading. mwah 💋 💅✨

📦 where this page comes from