c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the Cumulocity CLI, but make it make sense 🎀

okay bestie, welcome to the group chat ✨ this is the manual page for c8y, and yes we're doing the device services corner of it today. it's giving "small page, big family energy" ngl, because most of the flags you'll see here are literally just inherited from the parent command 😭 don't worry, we're covering every single one. no skips, no cap.

✨ NAME ✨

c8y-devices-services — Cumulocity device services 🦋

like, the device services part. of Cumulocity. you're welcome 💅

🌸 SYNOPSIS 🌸

c8y devices services [flags]

that's it. that's the whole summoning ritual. c8y devices services + whatever flags you feel like throwing at it ✨

💖 DESCRIPTION 💖

Managed device services — and yes, the little lore drop is right there in the original: these were introduced in 10.14 🎀 so if you're on something older, this whole page is a vibe check you're gonna fail, sorry bestie 😭

👑 OPTIONS 👑

the local ones. the home team. there's literally one. i love a low-effort queen 🫶

  • -h, --help[=false] — help for services 💫 the "wait what does this do again" button. iconic.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

okay so this is the part where the parent command shows up and is like "here, take all my flags" 💀 every single one is below, in order, no crumbs left behind. these are the ones that do the real heavy lifting.

  • --abortOnErrors=10 — abort the whole batch once you hit the specified number of errors 🛑 that's your "girl, we're done here" threshold.
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty 🙈 so your script doesn't have a meltdown over getting nothing.
  • --cache[=false] — enable cached responses ⚡ reuse instead of re-requesting, iykyk.
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. Empty indicates all values 🍓 so [] = hash everything, basically.
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m ⏳ how long the cached thing gets to live before it's ghosted.
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal ✨ tiny json, no vibes, maximum efficiency.
  • --confirm[=false] — prompt for confirmation 🫶 the "are you sure, bestie?" of flags.
  • --confirmText="" — custom confirmation text 💬 write your own dramatic warning.
  • --currentPage=0 — current page which should be returned 📄 page zero, we start at zero, respect the zero.
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' 🔗 yeet your own params into the URL.
  • --debug[=false] — set very verbose log messages 🔍 not just verbose. Very. she's loud and she's proud.
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s 😴 a lil breather after every call.
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s 🧘 same energy, but the warm-up stretch comes first.
  • --dry[=false] — dry run. Don't send any data to the server 🚫 nothing actually leaves the house. purely theoretical slay.
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl 📝 how your dry run dresses up. markdown is the default fit ✨
  • --examples[=false] — show examples for the current command 🎓 the "just show me, don't tell me" option.
  • --filter=[] — apply a client side filter to response before returning it to the user 🧜‍♀️ sift through the results on your side before they reach you.
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation 🪄 nested chaos → dot notation. a.b.c core fr.
  • -f, --force[=false] — do not prompt for confirmation. Ignored when using --confirm 💥 no questions asked. literally. (but head's up: --confirm overrides this one 👀)
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" 📨 send your own headers into the wild.
  • --includeAll[=false] — include all results by iterating through each page 🔁 every page, one after another, until there are none left. main character thoroughness.
  • -k, --insecure[=false] — allow insecure server connections when using SSL 🔓 trust issues: disabled. use with care, bestie.
  • -l, --logMessage="" — add custom message to the activity log 🗒️ leave a lil note in the history.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) 🚨 and the caution is in the original, so i'm passing it straight to you. unlimited is a lot. 🔥
  • --noAccept[=false] — ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect 🙃 exactly as written: the Accept header gets dropped, but only PUT and POST actually feel it.
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting) 💀 the cache setting doesn't get a vote.
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console 🎨🚫 monochrome mode, for when the rainbow is too much.
  • --noLog[=false] — disables the activity log for the current command 🤫 this one goes down in silence.
  • --noProgress[=false] — disable progress bars 📊 no lil loading bar, just vibes and waiting.
  • --noProxy[=false] — ignore the proxy settings 🚪 going direct, no middleman.
  • -n, --nullInput[=false] — don't read the input (stdin). Useful if using in shell for/while loops 🔂 so your loop doesn't get its stdin eaten. genuinely useful, ngl.
  • -o, --output="table" — output format i.e. table, json, csv, csvheader 📋 table is the default. dress accordingly.
  • --outputFile="" — save JSON output to file (after select/view) 💾 note the parenthetical — this is after select/view.
  • --outputFileRaw="" — save raw response to file (before select/view) 🗃️ and this one is before. order matters bestie, don't mix these up.
  • --outputTemplate="" — jsonnet template to apply to the output 🎀 jsonnet, not json, exactly as it says.
  • -p, --pageSize=5 — maximum results per page 📚 default is 5. yes, five. small pages, cozy.
  • --progress[=false] — show progress bar. This will also disable any other verbose output 🎡 and it takes the other verbose output out with it.
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080 🌉 tunnel through your proxy of choice.
  • -r, --raw[=false] — show raw response. This mode will force output=json and view=off 🪞 raw is raw — it takes over both of those settings, no negotiations.
  • --retries=3 — max number of attempts when a failed http call is encountered 🔄 three strikes-ish. default 3.
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' 🌟 pick exactly which properties you want. ** is the globstar, she's fancy.
  • --session="" — session configuration 🎫 your session settings.
  • --sessionMode="" — override default session mode for a single command which would normally be disabled 🦋 single-command override, nothing permanent.
  • -P, --sessionPassword="" — override session password 🔐
  • -U, --sessionUsername="" — override session username. i.e. peter or t1234/peter (with tenant) 👤 both forms, exactly as written — with tenant it's t1234/peter.
  • --silentExit[=false] — silent status codes do not affect the exit code 🤐 the status codes stay quiet and don't touch your exit code.
  • --silentStatusCodes="" — status codes which will not print out an error message 🔕 list the codes that stay quiet.
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m ⏰ default is 600s, so she's patient.
  • --totalPages=0 — total number of pages to get 📖 how far you're willing to go.
  • -v, --verbose[=false] — verbose logging 🗣️ more words. more details. more everything.
  • --view="auto" — use views when displaying data on the terminal. Disable using --view off 🖥️ default auto, and --view off is the off switch.
  • --withError[=false] — errors will be printed on stdout instead of stderr 🚚 errors move to a different stream. they're still errors, just relocated.
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13) 🔢 note the version — 10.13 — and note the path — .statistics.totalElements.
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages 📑 same energy, .statistics.totalPages, no version note on this one.
  • --workers=1 — number of workers 🐝 default 1. one little worker bee. add more if you're feeling brave.

🫶 SEE ALSO 🫶

the whole services fam, all of them, in order:

c8y-devices(1), c8y-devices-services-create(1), c8y-devices-services-delete(1), c8y-devices-services-find(1), c8y-devices-services-get(1), c8y-devices-services-list(1), c8y-devices-services-update(1)

create, delete, find, get, list, update — the full set 💖 go read them, they're right there.

💀 quick reminder: that --maxJobs=0 unlimited thing comes with a use with caution! straight from the source. i'm not being dramatic, the manpage said it first. 🌸

and that's the page bestie ✨ dating all the way back to Jan 1980 (yes, really, that's the date in the footer 😭), from the c8y(1) manual. now go forth and manage those device services, you absolute icon 👑💅

📦 where this page comes from