c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — tenantstatistics list, bestie 💅

okay so welcome to the c8y(1) page for the c8y-tenantstatistics-list command 💖 this is the one that gets tenant usage statistics, and yes it has a lot of inherited flags. no cap, we’re covering every single one.

🌸 NAME 🌸

c8y-tenantstatistics-list — Get tenant usage statistics ✨

✨ SYNOPSIS ✨

c8y tenantstatistics list [flags]

🦋 DESCRIPTION 🦋

Get collection of tenant usage statistics 🫶 that’s the whole vibe of this command, and it ate.

🎀 OPTIONS 🎀

  • --dateFrom="" — Start date or date and time of the statistics. literally your “from” moment ⏳
  • --dateTo="" — End date or date and time of the statistics. the “to” moment, bestie 💫
  • -h, --help[=false] — help for list. the built-in help, iconic as always 👑

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

these are inherited from the parent commands, and there are so many, but we’re listing every single one because that’s the rules 💅

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. stop the batch when it hits that error count 🛑
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). empty pipe is not a crisis, apparently 💀
  • --cache[=false] — Enable cached responses. cached responses go brrr 💾
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. so [] means all values, iykyk 🔍
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. let it live, then let it go ⏱️
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. cute and compact, depending on terminal vibes ✨
  • --confirm[=false] — Prompt for confirmation. yes/no moment fr fr 🙈
  • --confirmText="" — Custom confirmation text. make the prompt say what you want 💬
  • --currentPage=0 — Current page which should be returned. page zero, main character energy 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. add your own query-param lore 🔗
  • --debug[=false] — Set very verbose log messages. debug mode, very loud, very helpful 🔥
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. a lil pause after each request 🫧
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. a lil pause before each request 🫧
  • --dry[=false] — Dry run. Don't send any data to the server. pretend mode, no data sent 🧚
  • --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? yes please 👀
  • --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 gets the dot-notation treatment 🪄
  • -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, custom vibes 📨
  • --includeAll[=false] — Include all results by iterating through each page. all the pages, all the results 🔁
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. SSL but make it insecure, be careful bestie 😬
  • -l, --logMessage="" — Add custom message to the activity log. leave a lil note in the activity log 📝
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). unlimited jobs is powerful and also kinda scary, so 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. Accept header gets ignored, but PUT and POST are the ones that see the effect 🚫
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). no cache, override the cache setting 🧊
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. monochrome console moment 🖤
  • --noLog[=false] — Disables the activity log for the current command. no activity log for this command 🚫📝
  • --noProgress[=false] — Disable progress bars. no progress bars, just vibes 🫥
  • --noProxy[=false] — Ignore the proxy settings. proxy settings? ignored 🚫
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. no stdin reading, handy for shell for/while loops 🌀
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. choose your output format, bestie 📊
  • --outputFile="" — Save JSON output to file (after select/view). save it after select/view 💾
  • --outputFileRaw="" — Save raw response to file (before select/view). save the raw response before select/view 🗃️
  • --outputTemplate="" — jsonnet template to apply to the output. template time, jsonnet style 🧞
  • -p, --pageSize=5 — Maximum results per page. five per page by default, cute and tiny 📄
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. progress bar on, other verbose output 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 response mode forces output=json and view=off, no cap 📦
  • --retries=3 — Max number of attempts when a failed http call is encountered. three attempts when an http call fails 🔁
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. select your faves with wildcards and globstar 🌟
  • --session="" — Session configuration. session config goes here 🪪
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled. override session mode for one command 🎛️
  • -P, --sessionPassword="" — Override session password. password override, keep it secret bestie 🤫
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). username override, tenant included if you want 🧑‍💻
  • --silentExit[=false] — Silent status codes do not affect the exit code. silent status codes stay out of the exit code 🙊
  • --silentStatusCodes="" — Status codes which will not print out an error message. these status codes do not print an error message 🤐
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. request timeout, ten minutes by default ⏰
  • --totalPages=0 — Total number of pages to get. total pages, zero by default 📚
  • -v, --verbose[=false] — Verbose logging. verbose logging, very chatty 🗣️
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. views on the terminal, auto by default; disable with --view off 👀
  • --withError[=false] — Errors will be printed on stdout instead of stderr. errors on stdout, not stderr 📤
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). total elements, introduced in 10.13 ✨
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. total pages in the response statistics 📄
  • --workers=1 — Number of workers. one worker by default 🛠️

🌈 EXAMPLE 🌈

run these, bestie, they’re iconic:

$ c8y tenantstatistics list
Get tenant statistics collection

$ c8y tenantstatistics list --dateFrom "-30d" --pageSize 30
Get tenant statistics collection for the last 30 days

$ c8y tenantstatistics list --dateFrom "-3d" --dateTo "-2d"
Get tenant statistics collection for the day before yesterday

👑 SEE ALSO 👑

that’s the whole page, bestie 💖 this c8y(1) manual cutie is dated Jan 1980, and the manual name is c8y(1) — periodt, mwah 💅✨

📦 where this page comes from