c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the devicegroups glow-up 🎀

okay so this is a page from the c8y manual, bestie — that's the Cumulocity CLI, and today's main character is device groups. buckle up ✨

🌸 NAME 🌸

c8y-devicegroups — Cumulocity device groups. that's it, that's the vibe 💖

✨ SYNOPSIS ✨

c8y devicegroups [flags]

literally just that. no cap 🫶

🦋 DESCRIPTION 🦋

it's a REST endpoint situation for interacting with Cumulocity device groups. your fave little doorway into group land 👑

🎀 OPTIONS 🎀

  • -h, --help[=false] — shows you the help for devicegroups. the "wait what does this do again" button 🙈

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these are the family hand-me-downs, the inherited flags, and there are a lot of them. iykyk 🧚

  • --abortOnErrors=10 — aborts the whole batch once it hits this many errors. default is 10
  • --allowEmptyPipe[=false] — don't fail just because the piped input (stdin) is empty. iconique, honestly
  • --cache[=false] — turns on cached responses
  • --cacheBodyPaths=[] — the cache should only hash these selected paths in the json body. empty means all values, periodt
  • --cacheTTL="60s" — cache time-to-live (TTL) written as a duration, like 60s or 2m
  • -c, --compact[=false] — compact instead of pretty-printed output when you're using json output. pretty print is the default when output is the terminal ✨
  • --confirm[=false] — prompts you for confirmation
  • --confirmText="" — your own custom confirmation text 🎀
  • --currentPage=0 — the current page that should be returned
  • --customQueryParam=[] — add custom URL query parameters, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — sets very verbose log messages. like, all of them 💀
  • --delay="0ms" — delay after each request, like 5ms or 1.2s
  • --delayBefore="0ms" — delay before each request, like 5ms or 1.2s
  • --dry[=false] — dry run. sends absolutely zero data to the server 🚫
  • --dryFormat="markdown" — the dry run output format, like json, dump, markdown or curl
  • --examples[=false] — shows examples for the current command
  • --filter=[] — applies a client side filter to the response before it comes back to you
  • --flatten[=false] — flattens json output by replacing nested json properties with properties whose names use dot notation
  • -f, --force[=false] — do not prompt for confirmation. ignored when you're using --confirm
  • -H, --header=[] — custom headers, like --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — includes all the results by iterating through each page 🔁
  • -k, --insecure[=false] — allows insecure server connections when using SSL (yes, risky, don't @ me)
  • -l, --logMessage="" — adds a custom message to the activity log
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution! ⚠️)
  • --noAccept[=false] — ignores the Accept header, which removes the Accept header from requests; however PUT and POST requests will only see the effect
  • --noCache[=false] — forces cached responses off (this 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] — disables progress bars
  • --noProxy[=false] — ignores the proxy settings
  • -n, --nullInput[=false] — don't read the input (stdin). super useful if you're using shell for/while loops 🌀
  • -o, --output="table" — output format, like table, json, csv, csvheader
  • --outputFile="" — saves JSON output to a file (after select/view)
  • --outputFileRaw="" — saves the raw response to a file (before select/view)
  • --outputTemplate="" — the jsonnet template to apply to the output
  • -p, --pageSize=5 — maximum results per page. default 5, cute and small 🍓
  • --progress[=false] — shows a progress bar. this will also disable any other verbose output
  • --proxy="" — proxy setting, like http://10.0.0.1:8080
  • -r, --raw[=false] — shows the raw response. this mode forces output=json and view=off
  • --retries=3 — max number of attempts when a failed http call is encountered
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, like --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 the session password
  • -U, --sessionUsername="" — override the session username, like 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, like 60s or 2m
  • --totalPages=0 — total number of pages to get
  • -v, --verbose[=false] — verbose logging
  • --view="auto" — use views when displaying data on the terminal. disable with --view off
  • --withError[=false] — errors get printed on stdout instead of stderr
  • --withTotalElements[=false] — asks Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13)
  • -t, --withTotalPages[=false] — asks Cumulocity to include the total pages in the response statistics under .statistics.totalPages
  • --workers=1 — number of workers

🌈 SEE ALSO 🌈

the whole friend group 🫶 go check out:

that's the whole page, bestie — this one's dated Jan 1980 and it's a c8y(1) original 💖 slay, go group some devices 👑🎀

📦 where this page comes from