c8y(1)

📦 version 2.56.1, in nixpkgs unstable

okay bestie, welcome to the c8y(1) manual page for c8y-alarms-deleteCollection — this is the one that deletes a whole collection of alarms, and yes, it eats 💅✨

🎀 NAME 🎀

c8y-alarms-deleteCollection — Delete alarm collection 🫶

✨ SYNOPSIS ✨

c8y alarms deleteCollection [flags]

💅 DESCRIPTION 💅

This command deletes a collection of alarms by a filter you give it. Lowkey powerful, highkey dangerous if your filter is too loose — so vibe check your flags first, bestie 😭

🌸 OPTIONS 🌸

  • --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 occurred. 🕰️
  • --dateTo="" — end date, or date and time, of when the alarm occurred. 🕰️
  • --device=[] — source device id. This one accepts pipeline, iykyk 🫶
  • -h, --help[=false] — help for deleteCollection. Your little emergency exit button 💖
  • --processingMode="" — Cumulocity processing mode ⚙️
  • --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. Read that twice, bestie 🚨
  • --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, alarms for related source assets will also be removed. When you provide this parameter, source must also be defined. No source, no slay 🙈
  • --withSourceDevices[=false] — when set to true, alarms for related source devices will also be removed. When you provide this parameter, source must also be defined. Same vibe, same rule 🙈

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

  • --abortOnErrors=10 — abort the batch when it reaches the specified number of errors. 🛑
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). Empty pipe, no drama 🫶
  • --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. Safety check, bestie 🫶
  • --confirmText="" — custom confirmation text. Make it say whatever you need 💅
  • --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. Turn it up, detective 🔍
  • --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. Fake it till you make it, safely 💀
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl. 🎀
  • --examples[=false] — show examples for the current command. Show me the moves ✨
  • --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. Bold of you, bestie 💅
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" 📬
  • --includeAll[=false] — include all results by iterating through each page. All of it, no crumbs 👑
  • -k, --insecure[=false] — allow insecure server connections when using SSL. Bestie, this is literally the insecure option — be careful ⚠️
  • -l, --logMessage="" — add custom message to the activity log. 📝
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). Like, genuinely caution, bestie 🚨
  • --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. monochrome moment 🖤
  • --noLog[=false] — disables the activity log for the current command. 📴
  • --noProgress[=false] — disable progress bars. No little loading guys 😭
  • --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. Pick your aesthetic ✨
  • --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. Raw and unfiltered, periodt 💅
  • --retries=3 — max number of attempts when a failed http call is encountered. Try again, bestie 🔁
  • --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. Tell me everything 🔍
  • --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. Plot twist 💀
  • --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 🍓

First vibe: remove alarms on the device with the severity set to MAJOR 👑

$ c8y alarms deleteCollection --device 12345 --severity MAJOR

Then this one: remove alarms on the device which are active and created in the last 10 minutes ⏳

$ c8y alarms deleteCollection --device 12345 --dateFrom "-10m" --status ACTIVE

🌈 SEE ALSO 🌈

c8y-alarms(1) — go read that one too, bestie 🫶

that's the whole page, bestie — signing off from the Jan 1980 edition of c8y(1) 🎀✨💅

📦 where this page comes from