c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y(1) — the device groups list glow-up 💖

okay bestie, so this is a page from the c8y manual — section 1, the command-line one — and honestly? it's giving "I just want to see my device groups" and I respect it. sit down, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

c8y-devicegroups-list — literally just Get device group collection. that's the whole vibe. you want the groups, this gets you the groups. periodt. 👑

🦋 SYNOPSIS 🦋

c8y devicegroups list [flags]

🌸 DESCRIPTION 🌸

Get a collection of device groups based on filter parameters. no cap, that's it — you hand it some filters, it hands you back a whole collection of device groups. main character energy fr fr. 💅

🎀 OPTIONS 🎀

  • --excludeRootGroup[=false] — filter by group inclusion, bestie. (yes, both this and --group say "filter by group inclusion" — I don't make the rules, I just relay them faithfully 🫶)
  • --fragmentType="" — filter by fragment type.
  • --group=[] — filter by group inclusion. it's a list, so you can stack 'em.
  • -h, --help[=false] — help for list. your little safety net ✨
  • --name="" — filter by name. this one's the star of the example at the bottom, iykyk.
  • --orderBy="name" — order by, like _id asc or name asc or creationTime.date desc. defaults to name, because alphabetically is the moment.
  • --owner="" — filter by owner.
  • --query="" — additional query filter (accepts pipeline). fancy.
  • --queryTemplate="" — string template to be used when applying the given query. use %s to reference the query/pipeline input. so it's like mad-libs but for queries 💀
  • --skipChildrenNames[=false] — don't include the child devices names in the response. and honestly? this can improve the API response because the names don't need to be retrieved. faster = happier.
  • --type="" — filter by type.
  • --withChildren[=false] — include names of child assets. ⚠️ only use where necessary, as it is slow for large groups. no like seriously, big groups + this flag = pain.
  • --withChildrenCount[=false] — when set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices). counting era 🔥
  • --withGroups[=false] — when set to true it returns additional information about the groups to which the searched managed object belongs. this results in setting the assetParents property with additional information about the groups. extra lore, love that for you.
  • --withParents[=false] — include a flat list of all parents and grandparents of the given object. family tree reveal 🌈

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these aren't even hers, she inherited them, and there are SO many. but we're not skipping a single one, bestie. not one. 😭

  • --abortOnErrors=10 — abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe? still slaying.
  • --cache[=false] — enable cached responses.
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty indicates 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. 💅
  • --confirm[=false] — prompt for confirmation.
  • --confirmText="" — custom confirmation text. make it cute, make it yours.
  • --currentPage=0 — 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. get all up in the logs.
  • --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, not the real show 🎭
  • --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 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. flat like my emotional state 💀
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. (read that again: ignored when using --confirm)
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue".
  • --includeAll[=false] — include all results by iterating through each page. the completionist option.
  • -k, --insecure[=false] — allow insecure server connections when using SSL. ⚠️ yeah, that's what it says, bestie — go in with eyes open.
  • -l, --logMessage="" — add custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). the "use with caution" is doing a lot of heavy lifting there 🙈
  • --noAccept[=false] — ignore 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 cache setting).
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome moment.
  • --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. defaults to table.
  • --outputFile="" — save JSON output to file (after select/view).
  • --outputFileRaw="" — save raw response to file (before select/view). two different files, two different moments ✨
  • --outputTemplate="" — jsonnet template to apply to the output.
  • -p, --pageSize=5 — maximum results per page. default is 5, yes, five, that's really the default.
  • --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.
  • --retries=3 — max number of attempts when a failed http call is encountered. she's persistent 💪
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'.
  • --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).
  • --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's a whole ten minutes.
  • --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.
  • --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.

🔥 EXAMPLE 🔥

$ c8y devicegroups list --name "parent*"

get a collection of device groups with names that start with 'parent'. look at that wildcard go. ate. 👑

🧚 SEE ALSO 🧚

and that's the page, bestie! 🫶 it's from Jan 1980 (iconic vintage, honestly), it's page c8y(1) of the manual, and it's all yours now. go filter some groups. 💖

📦 where this page comes from