c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸ’… c8y(1) β€” the c8y software update glow-up πŸ¦‹

okay bestie, so this is the page for c8y, section 1 of the manual β€” and specifically the software update command. she's giving "managedObject maintenance" main character energy and honestly? iconic. let's get into it πŸŽ€


🌸 NAME 🌸

c8y-software-update β€” Update software. that's it, that's the vibe. you're updating an existing something and we're here for it πŸ’–


✨ SYNOPSIS ✨

c8y software update [flags]

literally just that. flags go brrr at the end 🫢


πŸ’œ DESCRIPTION πŸ’œ

Update an existing software package (managedObject). yes queen, you're editing a managedObject that already exists β€” no cap, lowkey the whole point of the command. πŸ¦‹


πŸ‘‘ OPTIONS πŸ‘‘

okay so these are the ones that belong to update itself β€” theδΈ“ε±ž ones, the inner circle:

  • -d, --data=[] β€” static data you want applied to the body. takes json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' β€” yes the shorthand is giving ✨convenience✨ and we stan
  • --description="" β€” the Description of the software package. tell the people what it is πŸ’…
  • --deviceType="" β€” Device type filter. only lets software be applied to devices of this type β€” picky in the best way πŸ’€
  • -h, --help[=false] β€” help for update. the classic "wait what does this do again" button πŸ™ˆ
  • --id=[] β€” Software package (managedObject) id. required bestie, do not forget her 😭 (also accepts pipeline 🫢)
  • --newName="" β€” New software package name. rebrand era 🌈
  • --processingMode="" β€” Cumulocity processing mode. iykyk
  • --softwareType="" β€” Software type. keep it labeled πŸŽ€
  • --template="" β€” Body template. your little fill-in-the-blank moment
  • --templateVars=[] β€” Body template variables. the blanks get filled ⭐

🧚 OPTIONS INHERITED FROM PARENT COMMANDS 🧚

these are the family hand-me-downs β€” inherited from the parent commands, and there are so many, but the rule is every single one shows up, so buckle up buttercup 🌸

  • --abortOnErrors=10 β€” Abort batch when reaching specified number of errors. ten strikes and you're out πŸ’€
  • --allowEmptyPipe[=false] β€” Don't fail when piped input is empty (stdin). be forgiving, it's cute πŸ’–
  • --cache[=false] β€” Enable cached responses. speed demon behavior πŸ”₯
  • --cacheBodyPaths=[] β€” Cache should limit hashing of selected paths in the json body. Empty indicates all values. ✨selective✨
  • --cacheTTL="60s" β€” Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. she expires, respectfully πŸŽ€
  • -c, --compact[=false] β€” Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. ngl the terminal default is the moment πŸ’…
  • --confirm[=false] β€” Prompt for confirmation. "u sure bestie?" 🫢
  • --confirmText="" β€” Custom confirmation text. say it with your chest
  • --currentPage=0 β€” Current page which should be returned. page one of the story πŸ“–
  • --customQueryParam=[] β€” add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' β€” ur own little remix 🌈
  • --debug[=false] β€” Set very verbose log messages. the diary entry mode 😭
  • --delay="0ms" β€” delay after each request, i.e. 5ms, 1.2s. manners ✨
  • --delayBefore="0ms" β€” delay before each request, i.e. 5ms, 1.2s. also manners, just earlier
  • --dry[=false] β€” Dry run. Don't send any data to the server. imaginary slay πŸ”₯
  • --dryFormat="markdown" β€” Dry run output format. i.e. json, dump, markdown or curl. pick ur aesthetic
  • --examples[=false] β€” Show examples for the current command. tutorial era πŸŽ€
  • --filter=[] β€” Apply a client side filter to response before returning it to the user. gatekeeping, but make it functional πŸ’…
  • --flatten[=false] β€” flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested β†’ flat, unbothered πŸ¦‹
  • -f, --force[=false] β€” Do not prompt for confirmation. Ignored when using --confirm. bold of you, but ok 😌
  • -H, --header=[] β€” custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" β€” accessorize ur request πŸŽ€
  • --includeAll[=false] β€” Include all results by iterating through each page. no crumbs left behind πŸ“
  • -k, --insecure[=false] β€” Allow insecure server connections when using SSL. > ⚠️ bestie this is literally the "insecure" one, pls be aware πŸ™ˆ
  • -l, --logMessage="" β€” Add custom message to the activity log. ur mark on history ✨
  • --maxJobs=0 β€” Maximum number of jobs. 0 = unlimited (use with caution!). > caution is literally printed in the manual, do not ignore her πŸ’€
  • --noAccept[=false] β€” Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. iykyk
  • --noCache[=false] β€” Force disabling of cached responses (overwrites cache setting). overrides, periodt πŸ’…
  • -M, --noColor[=false] β€” Don't use colors when displaying log entries on the console. muted mode πŸ™ˆ
  • --noLog[=false] β€” Disables the activity log for the current command. what happens in the command stays in the command
  • --noProgress[=false] β€” Disable progress bars. no bar, just vibes
  • --noProxy[=false] β€” Ignore the proxy settings. ✨bypass✨
  • -n, --nullInput[=false] β€” Don't read the input (stdin). Useful if using in shell for/while loops. she said no input today 🫢
  • -o, --output="table" β€” Output format i.e. table, json, csv, csvheader. default is a whole table, fancy
  • --outputFile="" β€” Save JSON output to file (after select/view). after, bestie, after πŸ’–
  • --outputFileRaw="" β€” Save raw response to file (before select/view). before this time 😭
  • --outputTemplate="" β€” jsonnet template to apply to the output. template girlie πŸŽ€
  • -p, --pageSize=5 β€” Maximum results per page. five little guys per page default 🌸
  • --progress[=false] β€” Show progress bar. This will also disable any other verbose output. pick a lane, progress bar πŸ’€
  • --proxy="" β€” Proxy setting, i.e. http://10.0.0.1:8080. routing queen
  • -r, --raw[=false] β€” Show raw response. This mode will force output=json and view=off. she forces things, respectfully πŸ”₯
  • --retries=3 β€” Max number of attempts when a failed http call is encountered. three tries, we're persistent πŸ’ͺ
  • --select=[] β€” Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' β€” the ** is giving globstar royalty πŸ‘‘
  • --session="" β€” Session configuration. ur session, ur rules
  • --sessionMode="" β€” Override default session mode for a single command which would normally be disabled. one-time exception energy 😌
  • -P, --sessionPassword="" β€” Override session password. shhh πŸ™ˆ
  • -U, --sessionUsername="" β€” Override session username. i.e. peter or t1234/peter (with tenant). hi peter 🫢
  • --silentExit[=false] β€” Silent status codes do not affect the exit code. quiet quitting, but literally
  • --silentStatusCodes="" β€” Status codes which will not print out an error message. shhh codes
  • --timeout="600s" β€” Request timeout duration, i.e. 60s, 2m. ten minutes of patience by default, generous queen πŸŽ€
  • --totalPages=0 β€” Total number of pages to get. how many chapters bestie πŸ“–
  • -v, --verbose[=false] β€” Verbose logging. say everything πŸ’…
  • --view="auto" β€” Use views when displaying data on the terminal. Disable using --view off. auto-mode main character 🌈
  • --withError[=false] β€” Errors will be printed on stdout instead of stderr. errors but make it stdout 😭
  • --withTotalElements[=false] β€” Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). version noted, bestie ⭐
  • -t, --withTotalPages[=false] β€” Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. page count slay
  • --workers=1 β€” Number of workers. one little worker by default, build ur squad πŸ’ͺ

πŸ“ EXAMPLE πŸ“

okay so here's the actual glow-up in action:

$ c8y software update --id 12345 --newName "my_custom_name" --data "{\"com_my_props\":{},\"value\":1}"
Update a software package

that's it. --id β†’ who, --newName β†’ her new name, --data β†’ the little json gift she gets. Update a software package. ate and left no crumbs πŸ”₯


πŸ”₯ SEE ALSO πŸ”₯


ngl this whole page is basically "update ur managedObject and be nice about it." no cap, you got this bestie πŸ’–βœ¨

much love from the c8y corner of the manual β€” documented back in Jan 1980, version vibes and all πŸŽ€ she's vintage, she's iconic, she's built different πŸ’…

πŸ“¦ where this page comes from