c8y(1)

📦 version 2.56.1, in nixpkgs unstable

okay so bestie, welcome to the c8y(1) manual page — yes, that’s the manual name, and no, we are not copying the header line like a boring NPC. This is the user groups list corner of the c8y universe, and it’s about to make sense. 💖

🌸 NAME 🌸

c8y-usergroups-list - Get user group collection. That’s the whole name, bestie — it’s giving “grab me the user group collection” energy. ✨

🦋 SYNOPSIS 🦋

c8y usergroups list [flags]

🎀 DESCRIPTION 🎀

Get collection of (user) groups. Yep, groups — plural — and this command is the main character that fetches them. 👑

✨ OPTIONS ✨

  • -h, --help[=false] — help for list. It’s the “wait, what does this do again?” button, and we respect it. 🫶
  • --tenant="" — Tenant. Drop your tenant right here, bestie. 🏠

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. It’s the “okay, we’re out” threshold. 😭
  • --allowEmptyPipe[=false] — Don’t fail when piped input is empty (stdin). Empty pipe? Not a crisis. 💅
  • --cache[=false] — Enable cached responses. Speedy vibes, with a little memory. ⭐
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. No paths picked means all of them, iykyk. 🧚
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. It’s literally a countdown for cache. ⏳
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. Terminal beautification stays on unless you say otherwise. 🌈
  • --confirm[=false] — Prompt for confirmation. A little “u sure?” moment. 🙈
  • --confirmText="" — Custom confirmation text. Put your own words in the confirmation pop-up. 💬
  • --currentPage=0 — Current page which should be returned. Page zero is where we start, no cap. 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Custom query energy, exactly as written. 🔥
  • --debug[=false] — Set very verbose log messages. It’s giving “tell me everything” mode. 💀
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. A little breather after every request. 😮‍💨
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. A little breather before every request. 🌬️
  • --dry[=false] — Dry run. Don’t send any data to the server. Practice run, no actual server drama. 🎭
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. Pick your dry-run aesthetic. 🎨
  • --examples[=false] — Show examples for the current command. Examples are self-care. 📚
  • --filter=[] — Apply a client side filter to response before returning it to the user. Filter it before it reaches you. 🧼
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. Nested json? We flatten it with dot notation. 🫓
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. No prompt, unless --confirm is in the chat. 💥
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". Custom headers, exactly like that. 📨
  • --includeAll[=false] — Include all results by iterating through each page. Every page gets an invite. 👯
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. Yes, it says insecure — tread carefully, bestie. ⚠️
  • -l, --logMessage="" — Add custom message to the activity log. Leave a little note in the log. 📝
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). Unlimited jobs is iconic but also a little unhinged. 🔥
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. Header gone — but only PUT and POST requests see the effect. 🫥
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). Cache off, override style. 🚫
  • -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. No log for this one, periodt. 🤐
  • --noProgress[=false] — Disable progress bars. No little bar doing its thing. 🚫
  • --noProxy[=false] — Ignore the proxy settings. Proxy? Never heard of her. 🙅
  • -n, --nullInput[=false] — Don’t read the input (stdin). Useful if using in shell for/while loops. No stdin reading — shell loops will thank you. 🔁
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. Pick your output fit. 🛍️
  • --outputFile="" — Save JSON output to file (after select/view). Save it after select/view. 💾
  • --outputFileRaw="" — Save raw response to file (before select/view). Save it before select/view. 🗂️
  • --outputTemplate="" — jsonnet template to apply to the output. Template glow-up for your output. 🪄
  • -p, --pageSize=5 — Maximum results per page. Five per page is the default. 🖐️
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. Progress bar on, extra verbose chatter off. 📊
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. Proxy goes here. 🌐
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. Raw mode is raw mode — it forces output=json and view=off. 🥩
  • --retries=3 — Max number of attempts when a failed http call is encountered. Three attempts before we accept defeat. 😤
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Choose your properties, wildcards included. 🎯
  • --session="" — Session configuration. Session config lives here. 🔐
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled. One-command session mode override. 🎛️
  • -P, --sessionPassword="" — Override session password. Password override, quietly. 🤫
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). Username override, with tenant option. 🪪
  • --silentExit[=false] — Silent status codes do not affect the exit code. Silent status codes stay out of the exit code’s business. 🤐
  • --silentStatusCodes="" — Status codes which will not print out an error message. These status codes keep their error messages to themselves. 🙊
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. Ten minutes by default, bestie. ⏱️
  • --totalPages=0 — Total number of pages to get. How many pages are we getting? This many. 📚
  • -v, --verbose[=false] — Verbose logging. More words, more detail, more vibes. 🗣️
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. Views on auto, unless you say --view off. 👀
  • --withError[=false] — Errors will be printed on stdout instead of stderr. Errors go to stdout instead of stderr. 📤
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Total elements under .statistics.totalElements, and yes, introduced in 10.13. 🔢
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Total pages under .statistics.totalPages. 📄
  • --workers=1 — Number of workers. One worker by default, but you can change it. 🛠️

🦋 EXAMPLE 🦋

$ c8y usergroups list
Get a list of user groups for the current tenant

🎀 SEE ALSO 🎀

that’s the whole page, bestie — source/version c8y(1), dated Jan 1980. mwah 💋

📦 where this page comes from