c8y(1)

📦 version 2.56.1, in nixpkgs unstable

okay so bestie, welcome to c8y(1) — this page is all about c8y-alarms-updateCollection, and yes, alarm collection update is the main character today. 💅 Not me being obsessed with an alarm updater, but here we are. 🫶

🌸 NAME 🌸

c8y-alarms-updateCollection — update alarm collection. That's literally the whole name, no cap. 🎀

✨ SYNOPSIS ✨

c8y alarms updateCollection [flags]

🦋 DESCRIPTION 🦋

You're updating the status of a collection of alarms by using a filter. Currently only the status of alarms can be changed — that's the whole menu, bestie. periodt. 💖

💅 OPTIONS 💅

Ok these are the options for the update itself, and they are lowkey iconic. Let's go. 🍓

  • --createdFrom="" — start date or date and time of the alarm creation. Version >= 10.11.
  • --createdTo="" — end date or date and time of the alarm creation. Version >= 10.11.
  • -d, --data=[] — static data to be applied to body. Accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'. slay those nested values.
  • --dateFrom="" — start date or date and time of alarm occurrence.
  • --dateTo="" — end date or date and time of alarm occurrence.
  • --device=[] — the ManagedObject that the alarm originated from (accepts pipeline). 🫶
  • -h, --help[=false] — help for updateCollection.
  • --newStatus="" — new status to be applied to all of the matching alarms.
  • --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.
  • --severity="" — the severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case. ⚠️
  • --status="" — the status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED. If status was not appeared, new alarm will have status ACTIVE. Must be upper-case. 👑
  • --template="" — body template.
  • --templateVars=[] — body template variables.

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

These are the parent-command options — the family plan, if you will. 🫶 Every single one, bestie, no skips. ✨

  • --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. cache era.
  • -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!). 💀
  • --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 🔥

This is the example, and it eats:

$ c8y alarms updateCollection --device 12345 --status ACTIVE --newStatus ACKNOWLEDGED

Update the status of all active alarms on a device to ACKNOWLEDGED — iykyk 💅

🌈 SEE ALSO 🌈

okay that's the page, bestie 💖 stay iconic. This cutie manual page is c8y(1), dated Jan 1980. 🎀

📦 where this page comes from