c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🦋 c8y — software versions install 🦋

okay so bestie, you want to install a software version on a device? say less. this is the manual page for the c8y-software-versions-install command and it's literally gonna walk you through every single flag. no cap, i'm not skipping anything. periodt. 💅

✨ SYNOPSIS ✨

c8y software versions install [flags]

🌸 DESCRIPTION 🌸

Install software version on a device. that's the whole vibe. you point it at a device, tell it what software and version you want, and it makes it happen. iconic behavior honestly. ✨

💖 OPTIONS 💖 (the main character section)

  • --action="install" — Software action. the default is "install" and honestly that's the whole point of this command, so like, yeah. 🫶
  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'. very slay, very flexible. ✨
  • --description="Install software package" — Operation description. defaults to "Install software package" which is, honestly, exactly what it is. 🎀
  • --device=[] — Device or agent where the software should be installed (accepts pipeline). yes bestie, you can pipe it in. iykyk. 🔥
  • -h, --help[=false] — help for install. the classic. when in doubt, -h it out. 💅
  • --processingMode="" — Cumulocity processing mode. leave it empty unless you know what you're doing (and if you do, you ate). 👑
  • --software="" — Software name. required. like, you literally cannot do this without it. no software, no install. periodt. 💀
  • --softwareType="" — Software type. Leave blank to automatically set it if a matching software/version is found in the c8y software repository. the command is smart, let it cook. 🧚
  • --template="" — Body template. for when you want to customize the body, you fancy thing. 🌸
  • --templateVars=[] — Body template variables. the little helpers for your template. 🎀
  • --url="" — Software url. Leave blank to automatically set it if a matching software/version is found in the c8y software repository. again, let the command do its thing. 🔥
  • --version="" — Software version id or name. which version? this one. 💖

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈 (the family tree, we love her)

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. default is 10 errors before it taps out. reasonable tbh. 🫶
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). because sometimes the pipe is just empty and that's valid. 💅
  • --cache[=false] — Enable cached responses. speed. ✨
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. so if it's empty, it's hashing everything. 🌸
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. default is "60s". 🎀
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. so if you're in a terminal, it's pretty by default. iconic. 👑
  • --confirm[=false] — Prompt for confirmation. the "are you sure bestie" flag. 🙈
  • --confirmText="" — Custom confirmation text. make it say whatever you want. 💖
  • --currentPage=0 — Current page which should be returned. pagination vibes. 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. you do you. 🔥
  • --debug[=false] — Set very verbose log messages. for when you need to see everything. 🕵️
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. default is "0ms" (no delay). 🕰️
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. default is "0ms" too. 🕰️
  • --dry[=false] — Dry run. Don't send any data to the server. just a little preview, a little test drive. 🚗
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. default is "markdown". 📝
  • --examples[=false] — Show examples for the current command. yes please, show me how it's done. ✨
  • --filter=[] — Apply a client side filter to response before returning it to the user. like a little sieve for your data. 🌸
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. so a.b.c instead of nested objects. honestly so much easier to read. 💅
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. the "i said what i said" flag. 🔥
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". for the header girlies. 🎀
  • --includeAll[=false] — Include all results by iterating through each page. all of it. every last crumb. 🍪
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. ⚠️ careful bestie, this is literally insecure. only if you know what you're doing. 🙈
  • -l, --logMessage="" — Add custom message to the activity log. leave a little note for future you. 💌
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). ⚠️ use with caution is right there in the original, i'm just saying. 💀
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. very specific, very niche, very demure. 👑
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). no cache, no lies. 🌸
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. for the minimalist girlies. 🖤
  • --noLog[=false] — Disables the activity log for the current command. no receipts. 🙈
  • --noProgress[=false] — Disable progress bars. i don't need to see the journey, just the destination. ✨
  • --noProxy[=false] — Ignore the proxy settings. proxy whomst? 🚫
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. very handy. 🌟
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. default is "table". 🎀
  • --outputFile="" — Save JSON output to file (after select/view). 💾
  • --outputFileRaw="" — Save raw response to file (before select/view). the raw, unfiltered version. 💾
  • --outputTemplate="" — jsonnet template to apply to the output. for the jsonnet girlies. 🧚
  • -p, --pageSize=5 — Maximum results per page. default is 5. small and manageable. 🌸
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. so you can't have your cake and eat it too. 🍰
  • --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. raw dogging the response, so to speak. 💀
  • --retries=3 — Max number of attempts when a failed http call is encountered. default is 3. try, try again. 💪
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. so you can pick and choose. 🌸
  • --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). so you can be anyone you want to be. 🎭
  • --silentExit[=false] — Silent status codes do not affect the exit code. 🚪
  • --silentStatusCodes="" — Status codes which will not print out an error message. the quiet ones. 🤫
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. default is "600s". so much time, but like, respect. ⏳
  • --totalPages=0 — Total number of pages to get. how many pages you want. 📄
  • -v, --verbose[=false] — Verbose logging. for the girlies who need to know everything. 👀
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. default is "auto". 🎀
  • --withError[=false] — Errors will be printed on stdout instead of stderr. so errors go to the normal output, not the red text. 🚨
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). very specific, very useful. 🔢
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. same energy, different stat. 📊
  • --workers=1 — Number of workers. default is 1. one worker, one dream. 🛠️

🔥 EXAMPLE 🔥 (let's see it in action)

$ c8y software versions install --device 1234 --software go-c8y-cli --version 1.0.0

Install a software package version. If the software/version exists in the software repository, then it will add the url automatically. bestie, it's literally doing the work for you. 🫶

$ c8y software versions install --device 1234 --software go-c8y-cli --version 1.0.0 --url "https://mybloblstore/go-c8y-cli.deb"

Install a software package version with an explicit url. when you know exactly what you want and where it lives. 💅

🦋 SEE ALSO 🦋

c8y-software-versions(1) — the parent command, the origin story, the mothership. go check her out. ✨

okay so that's literally it bestie. every flag, every default, every little detail. you're welcome. now go install some software and slay. 💖✨🎀🦋

— go-c8y-cli edition, dated Jan 1980, manual name c8y. it's giving vintage but make it fresh. periodt. 💅

📦 where this page comes from