c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — c8y-tenantstatistics-listSummaryAllTenants ✨

okay so bestie, you're holding the c8y(1) manual page and honestly? this one's a whole vibe. it's the tenant-statistics summary command and it ate. let's get into it 🫶

🌸 NAME 🌸

c8y-tenantstatistics-listSummaryAllTenants — get all tenant usage summary statistics. yes, ALL of them. no crumbs left behind 💅

✨ SYNOPSIS ✨

c8y tenantstatistics listSummaryAllTenants [flags]

🦋 DESCRIPTION 🦋

Get collection of tenant usage statistics summary. that's it, that's the whole thing — you're pulling back the full collection of summaries, and it's giving main character energy fr fr 🔥

🎀 OPTIONS 🎀

  • --dateFrom="" — start date, or start date and time, of the statistics. leave it empty and you get whatever the default window is 👑
  • --dateTo="" — end date, or end date and time, of the statistics. also empty by default, no cap 🌸
  • -h, --help[=false] — help for listSummaryAllTenants. your little emergency "what does this do again" button, default false 🧚

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these are the ones you didn't ask for but got anyway, like a group chat you never left. all of them, in order, no skipping 🙈

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors. default is 10 — literally built-in patience 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. default false 🍓
  • --cache[=false] — enable cached responses. default false, sad but true ✨
  • --cacheBodyPaths=[] — cache should limit hashing of the selected paths in the json body. empty indicates all values 💅
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. default "60s" 🕐
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal. default false 💖
  • --confirm[=false] — prompt for confirmation. default false 🌸
  • --confirmText="" — custom confirmation text 🎀
  • --currentPage=0 — current page which should be returned. default 0 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' 🔗
  • --debug[=false] — set very verbose log messages. default false 🐛
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. default "0ms" ⏳
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. default "0ms" ⏳
  • --dry[=false] — dry run. don't send any data to the server. default false 🧪
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl. default "markdown" 📝
  • --examples[=false] — show examples for the current command. default false 🌈
  • --filter=[] — apply a client side filter to the response before returning it to the user. default [] 🧹
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. default false 🪄
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. default false 💪
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" 📨
  • --includeAll[=false] — include all results by iterating through each page. default false 📚
  • -k, --insecure[=false] — allow insecure server connections when using SSL. default false 🔓
  • -l, --logMessage="" — add custom message to the activity log ✍️
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). default 0 ⚠️
  • --noAccept[=false] — ignore Accept header; will remove the Accept header from requests, however PUT and POST requests will only see the effect. default false 🚫
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). default false 🙅
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. default false 🎨
  • --noLog[=false] — disables the activity log for the current command. default false 🤐
  • --noProgress[=false] — disable progress bars. default false 🚫
  • --noProxy[=false] — ignore the proxy settings. default false 🕳️
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. default false 🔇
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader. default "table" 📊
  • --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. default false 📶
  • --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. default false 🥩
  • --retries=3 — max number of attempts when a failed http call is encountered. default 3 🔁
  • --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. default false 🤫
  • --silentStatusCodes="" — status codes which will not print out an error message 🙊
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. default "600s" ⏱️
  • --totalPages=0 — total number of pages to get. default 0 🗂️
  • -v, --verbose[=false] — verbose logging. default false 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable using --view off. default "auto" 👀
  • --withError[=false] — errors will be printed on stdout instead of stderr. default false 📤
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). default false 🔢
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. default false 🧮
  • --workers=1 — number of workers. default 1 👷

🔥 EXAMPLE 🔥

bestie these examples are iconic, copy them exactly:

$ c8y tenantstatistics listSummaryAllTenants
Get tenant summary statistics for all tenants
$ c8y tenantstatistics listSummaryAllTenants --dateFrom "-30d"
Get tenant summary statistics collection for the last 30 days
$ c8y tenantstatistics listSummaryAllTenants --dateFrom "-10d" --dateTo "-9d"
Get tenant summary statistics collection for the last 10 days, only return until the last 9 days

see how --dateFrom and --dateTo are doing the absolute most? that's a time window, periodt 🕰️✨

🌟 SEE ALSO 🌟

ngl the inherited options list is long enough to be its own trilogy, but every single one is here so you're never gonna get jumpscared by a flag you didn't know about 💀💖

and that's a wrap, bestie 🎀 this page was served up from the c8y(1) manual, dated Jan 1980 — vintage but still slaying ✨ go get those tenant summaries, you've got this 💅🦋

📦 where this page comes from