c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y manual page, but make it make sense

okay so bestie, welcome to the c8y man page 🫶 this is the whole thing, every flag, every default, nothing skipped. i'm literally not letting you scroll past a single option. you're welcome 💖

✨ NAME ✨

c8y-alarms-count — Retrieve the total number of alarms

🌸 SYNOPSIS 🌸

c8y alarms count [flags]

🦋 DESCRIPTION 🦋

Count the total number of active alarms on your tenant. that's it. that's the whole vibe ✨

🎀 OPTIONS 🎀

  • --dateFrom="" — start date, or date and time, of when the alarm happened.
  • --dateTo="" — end date, or date and time, of when the alarm happened.
  • --device=[] — source device id. and yes, it accepts a pipeline 🫶
  • -h, --help[=false] — help for count.
  • --resolved[=false] — when it's set to true, only resolved alarms get removed (the ones with status CLEARED); false means alarms with status ACTIVE or ACKNOWLEDGED.
  • --severity="" — alarm severity, like CRITICAL, MAJOR, MINOR or WARNING.
  • --status=[] — comma separated alarm statuses, like ACTIVE,CLEARED.
  • --type="" — alarm type.
  • --withSourceAssets[=false] — when true, alarms for related source devices also get included in the request. when you pass this, a source must be specified.
  • --withSourceDevices[=false] — when true, alarms for related source devices also get removed. when you pass this, a source must also be defined.

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the ones you get for free from the parent command, no cap:

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty.
  • --cache[=false] — enable cached responses.
  • --cacheBodyPaths=[] — restrict which selected paths in the json body get hashed for the cache. empty means 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 the output is the terminal.
  • --confirm[=false] — prompt for confirmation.
  • --confirmText="" — custom confirmation text.
  • --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.
  • --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 the 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 a custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!).
  • --noAccept[=false] — ignore the Accept header; this removes the Accept header from requests, however PUT and POST requests will only see the effect.
  • --noCache[=false] — force disabling of cached responses (overwrites the 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 you're using it in shell for/while loops.
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader.
  • --outputFile="" — save JSON output to a file (after select/view).
  • --outputFileRaw="" — save the raw response to a 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 the 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 🔥

okay these examples ate, fr fr 👑

$ c8y alarms count --severity MAJOR
Get number of active alarms with the severity set to MAJOR

get the number of active alarms with the severity set to MAJOR.

$ c8y alarms count --dateFrom "-10m" --status ACTIVE
Get number of active alarms which occurred in the last 10 minutes

get the number of active alarms that occurred in the last 10 minutes.

$ c8y alarms count --dateFrom "-10m" --status ACTIVE --device 12345
Get number of active alarms which occurred in the last 10 minutes on a device

get the number of active alarms that occurred in the last 10 minutes on a device.

$ c8y devices list --type linuxA | c8y alarms count --dateFrom "-10m"
Get number of alarms from a list of devices using pipeline

get the number of alarms from a list of devices, using a pipeline 🫶

🌈 SEE ALSO 🌈

c8y-alarms(1)

and that's the whole page bestie, you're officially an alarms-counting icon 💅✨ this edition is dated Jan 1980 and comes from c8y(1) — go forth and count, you've got this 🎀🦋💜

📦 where this page comes from