c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🎀 c8y(1) — the c8y alarms list glow-up 🎀

okay so bestie, you opened the c8y manual page (that's the c8y(1) header, yes ma'am 💅) and landed straight on c8y-alarms-list. Don't panic, I got you. This is literally the whole thing, nothing skipped, periodt. ✨

🌸 NAME 🌸

c8y-alarms-list — get alarm collection. that's it, that's the vibe. 💖

🦋 SYNOPSIS 🦋

c8y alarms list [flags]

✨ DESCRIPTION ✨

Get a collection of alarms based on filter parameters. You're basically walking into the alarm closet and picking exactly which ones you want to see. Obsessed. 🫶

👑 OPTIONS 👑

all the flags, no gatekeeping, fr fr:

  • --createdFrom="" — start date, or date and time, of when the alarm was created. Version >= 10.11 💫
  • --createdTo="" — end date, or date and time, of when the alarm was created. Version >= 10.11 💫
  • --dateFrom="" — start date, or date and time, of when the alarm actually occurred.
  • --dateTo="" — end date, or date and time, of when the alarm actually occurred.
  • --device=[] — source device id. (accepts pipeline 🌀)
  • -h, --help[=false] — help for list. ur little safety net.
  • --lastUpdatedFrom="" — start date, or date and time, of the last update made. Version >= 10.11 💫
  • --lastUpdatedTo="" — end date, or date and time, of the last update made. Version >= 10.11 💫
  • --resolved[=false] — when set to true only resolved alarms will be removed (the one with status CLEARED); false means alarms with status ACTIVE or ACKNOWLEDGED. 🚨
  • --severity="" — alarm severity, for example CRITICAL, MAJOR, MINOR or WARNING.
  • --status=[] — comma separated alarm statuses, for example ACTIVE,CLEARED.
  • --type="" — alarm type.
  • --withSourceAssets[=false] — when set to true also alarms for related source devices will be included in the request. When this parameter is provided a source must be specified. ⚠️ like, it's not optional-optional, bestie.
  • --withSourceDevices[=false] — when set to true also alarms for related source devices will be removed. When this parameter is provided also source must be defined. ⚠️ same energy.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

the family hand-me-downs, every single one, iconique:

  • --abortOnErrors=10 — abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin).
  • --cache[=false] — enable cached responses.
  • --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.
  • --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 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!) 💀 for real, 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 🔥

the receipts, literally copy-paste these:

$ c8y alarms list --severity MAJOR --pageSize 100
Get alarms with the severity set to MAJOR
$ c8y alarms list --dateFrom "-10m" --status ACTIVE
Get collection of active alarms which occurred in the last 10 minutes
$ c8y alarms list --dateFrom "-1d" --status ACTIVE --status ACKNOWLEDGED
Get collection of active and acknowledged alarms in the last 1d

💜 SEE ALSO 💜

ngl, that's the whole page. nothing hidden, nothing skipped. slay. 💅

and that's a wrap, babe — this was c8y(1), dated Jan 1980 (yes, vintage 😭 iconic), signed off with love from your favourite manual. 🍓🌸💖

📦 where this page comes from