c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y manual page, bestie edition

okay so you found the c8y man page and you're like "what is all this" — don't panic, I got you. This is the manual for the c8y CLI, and this specific page is all about the delete command for device groups. We're gonna go through it together, every single flag, no skips, no cap. 🫶

✨ NAME ✨

c8y-devicegroups-delete — literally just: delete a device group. that's the whole vibe. 💅

🌸 SYNOPSIS 🌸

c8y devicegroups delete [flags]

that's it. that's the shape of it. c8y, then devicegroups, then delete, then whatever flags you feel like. 🎀

🦋 DESCRIPTION 🦋

So you've got a device group that's living in your tenant and honestly? it's gotta go. This command deletes an existing device group — and optionally all of its children too. yes, the children. we can be dramatic about it if you want. 😭

⭐ OPTIONS ⭐

the main character flags, right here:

  • --cascade[=false] — removes all child devices and child assets, deleted recursively. by default, the delete operation is propagated to the subgroups only if the deleted object is a group. so like, default behaviour is a little more chill than full cascade. 🍓
  • -h, --help[=false] — help for delete. the classic. when in doubt, ask for help. ✨
  • --id=[] — the device group ID. required, babes. it also accepts pipeline input, so you can pipe it in. 👑
  • --processingMode="" — Cumulocity processing mode. that's the setting, pass it whatever mode you need. 🌈

💖 OPTIONS INHERITED FROM PARENT COMMANDS 💖

these are the ones that come from the parent command, so you get them for free. it's giving hand-me-downs but make it ✨useful✨. ngl there are a LOT so buckle up, we're going through every single one:

  • --abortOnErrors=10 — abort the batch when it hits the specified number of errors. default is 10. 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. very forgiving of you. 🫶
  • --cache[=false] — enable cached responses.
  • --cacheBodyPaths=[] — the 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. aesthetic choice, honestly. 🌸
  • --confirm[=false] — prompt for confirmation.
  • --confirmText="" — custom confirmation text. make it say whatever you want. 💬
  • --currentPage=0 — the 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. for when you want to see EVERYTHING. 🔍
  • --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. rehearsal mode, basically. 🎭
  • --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. (yes, they fight. --confirm wins.)
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — include all results by iterating through each page. all of them. every last one. 💜
  • -k, --insecure[=false] — allow insecure server connections when using SSL. ⚠️ insecure is right there in the name, bestie, be careful.
  • -l, --logMessage="" — add a custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). they literally put the caution in the manpage so I'm passing it to you. 🚨
  • --noAccept[=false] — ignore the 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 the 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. default 5.
  • --progress[=false] — show progress bar. this will also disable any other verbose output.
  • --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. it does not ask. 😤
  • --retries=3 — max number of attempts when a failed http call is encountered. it tries, it tries again, it tries 3 times total by default. 🔁
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
  • --session="" — session configuration.
  • --sessionMode="" — override the 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. default is 600s of patience.
  • --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. redirect it wherever you want, icon. 🌈
  • --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. default 1.

🔥 EXAMPLE 🔥

okay here's the actual usage, look at her go:

$ c8y devicegroups delete --id 12345
Get device group by id

(yes, that description in the original says "Get device group by id" even though it's a delete command — I'm not gonna lie to you, I'm just relaying what the page says. 🙈)

🎀 SEE ALSO 🎀

  • c8y-devicegroups(1) — go read the parent page, she's the whole reason this one exists. 💖
one lil reminder before you dip: this command deletes stuff. --cascade[=false] can take out child devices and child assets recursively. double-check your --id before you commit, bestie. no take-backs. 😭

and that's the whole page! brought to you by the c8y manual, dated Jan 1980 (yes really, that's what it says at the bottom), version/title c8y(1) — she's vintage, she's iconic, she's a command-line tool. slay. 👑💅✨

📦 where this page comes from