c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌸 NAME 🌸

okay so bestie, welcome to the c8y(1) page — we're looking at c8y-smartgroups-list — List smart group collection. That's the name, and yes, it's giving "list all the smart groups" main character energy. No cap 💅

✨ SYNOPSIS ✨

Here's the whole vibe:

c8y smartgroups list [flags]

🦋 DESCRIPTION 🦋

Get a collection of smart groups based on filter parameters. You're literally pulling a collection of smart groups, filtered by whatever parameters you pass in. It's giving curated collection, bestie 🫶

💅 OPTIONS 💅

These are the flags for the list command itself. One bullet per option, no skips, periodt:

  • --deviceQuery="" — Filter by device query. That's the whole assignment, bestie.
  • --fragmentType="" — Filter by fragment type. Fragment-type filter era ✨
  • -h, --help[=false] — help for list. Iconic help behavior.
  • --name="" — Filter by name. Name filter, obviously.
  • --onlyInvisible[=false] — Only include invisible smart groups. Sneaky little smart groups 👀
  • --onlyVisible[=false] — Only include visible smart groups. Main-character visible smart groups only.
  • --orderBy="name" — Order by. e.g. _id asc or name asc or creationTime.date desc. Sorting vibes.
  • --owner="" — Filter by owner. Owner filter, iykyk.
  • --query="" — Additional query filter (accepts pipeline). Extra query filter, and yes it accepts pipeline.
  • --queryTemplate="" — String template to be used when applying the given query. Use %s to reference the query/pipeline input.
  • --skipChildrenNames[=false] — Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved.
  • --withChildren[=false] — Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance.
  • --withChildrenCount[=false] — When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices).
  • --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.
  • --withParents[=false] — Include a flat list of all parents and grandparents of the given object. Parent/grandparent flat-list realness.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

These are the parent-command options, and yes there are a lot of them. We're listing every single one, bestie 💖

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. The default is 10, and it's literally in the name.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). Empty stdin does not have to be a whole crisis.
  • --cache[=false] — Enable cached responses. Cache era.
  • --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. Yes, it asks first.
  • --confirmText="" — Custom confirmation text. Your own confirmation wording, slay.
  • --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. Very verbose debug energy.
  • --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.
  • --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.
  • -f, --force[=false] — Do not prompt for confirmation. 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.
  • -k, --insecure[=false] — Allow insecure server connections when using SSL.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!).
  • --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.
  • --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.
  • --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.
  • --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.
  • --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 🎀

Bestie, here's how it looks in the wild:

$ c8y smartgroups list

Get a list of smart groups.

$ c8y smartgroups list --name "myText*"

Get a list of smart groups with the names starting with 'myText'.

$ c8y smartgroups list --name "myText*" | c8y devices list

Get a list of smart groups with their names starting with 'myText', then get the devices from the smart groups.

🫶 SEE ALSO 🫶

mwah 💋 — this page says c8y(1) and it's dated Jan 1980. bye bestie, go slay those smart groups ✨👑

📦 where this page comes from