c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y-alarms-create — Create alarm 💖

Okay bestie, welcome to the c8y manual! This page is literally all about making alarms pop off on a device or agent. No cap, it's giving main character energy for your monitoring setup. ✨

🌸 SYNOPSIS 🌸

c8y alarms create [flags]

🦋 DESCRIPTION 🦋

So here's the vibe: you use this to create an alarm on a device or agent. That's it, that's the whole mood. Slay. 💅

✨ OPTIONS ✨

Ugh, okay, there are a lot of these but don't stress — I got you. Every single flag is right here, no gatekeeping. 🫶

  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'. Lowkey iconic for injecting exactly what you want. 🎀
  • --device=[] — The ManagedObject that the alarm originated from (accepts pipeline). This is the whole "where did this alarm come from" situation. 🦋
  • -h, --help[=false] — help for create. When you're lost, just ask for help, bestie. 💖
  • --processingMode="" — Cumulocity processing mode. It's giving "backend vibes only." ✨
  • --severity="" — The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case. Periodt. No lowercase nonsense allowed. 💀
  • --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. We love a default. 🌈
  • --template="" — Body template. For when you want that custom aesthetic. 🎨
  • --templateVars=[] — Body template variables. The little details that make it hit different. ✨
  • --text="" — Text description of the alarm. Say what you mean, bestie. 💬
  • --time="" — Time of the alarm. Defaults to current timestamp. If you don't specify, it just uses "now." Slay. ⏰
  • --type="" — Identifies the type of this alarm, e.g. 'com_cumulocity_events_TamperEvent'. Gotta label your alarm correctly, iykyk. 👑

🧚 OPTIONS INHERITED FROM PARENT COMMANDS 🧚

These are the flags that come from the parent command — they're not new, but they're still valid and you need to know them. Respect the lineage. 💜

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. Sometimes you just gotta know when to stop. 🛑
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). Forgiving queen behavior. 🫶
  • --cache[=false] — Enable cached responses. Speed is sexy. ⚡
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. Very "only the important stuff" energy. 🎯
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. Don't let that cache get stale, bestie. ⌛
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. Sometimes you want it neat, sometimes you want it compact. Both are valid. ✨
  • --confirm[=false] — Prompt for confirmation. Are you sure? Are you sure sure? 🙈
  • --confirmText="" — Custom confirmation text. Make it say whatever you want. 💬
  • --currentPage=0 — Current page which should be returned. Page one is where it's at. 📖
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. For the girlies who need extra customization. 🎀
  • --debug[=false] — Set very verbose log messages. When you need to see everything. 👀
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. Patience is a virtue, fr fr. ⏳
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Sometimes you gotta wait before you go. 🕰️
  • --dry[=false] — Dry run. Don't send any data to the server. Just practice. No commitment. 💅
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. Pick your aesthetic. 🎨
  • --examples[=false] — Show examples for the current command. We love a tutorial moment. 📚
  • --filter=[] — Apply a client side filter to response before returning it to the user. Only show what you want to see. 🎯
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. Making it all flat and easy. 🫶
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. No time for questions, just do it. 🔥
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". For when you need to add that extra spice. 🌶️
  • --includeAll[=false] — Include all results by iterating through each page. Get everything, no cap. 👑
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. Proceed with caution, bestie. 💀
  • -l, --logMessage="" — Add custom message to the activity log. Leave your mark. 💌
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). Be careful, okay? ⚠️
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. Technical behavior, but we respect it. 🧠
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). Fresh data only. 🆕
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. For when you want a minimalist aesthetic. 🖤
  • --noLog[=false] — Disables the activity log for the current command. Sometimes you want to go off the record. 🤫
  • --noProgress[=false] — Disable progress bars. No distractions. 🚫
  • --noProxy[=false] — Ignore the proxy settings. Direct connection, no middleman. 📡
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. Perfect for scripting, bestie. 💻
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. Pick your vibe. 📊
  • --outputFile="" — Save JSON output to file (after select/view). Save it for later. 💾
  • --outputFileRaw="" — Save raw response to file (before select/view). The raw, unfiltered version. 🌿
  • --outputTemplate="" — jsonnet template to apply to the output. For the customizable girlies. 🎀
  • -p, --pageSize=5 — Maximum results per page. Five at a time. That's the default, periodt. 5️⃣
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. Visual confirmation is nice. 📈
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. For when you need to go through a middleman. 🔄
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. No filter, just vibes. 🌿
  • --retries=3 — Max number of attempts when a failed http call is encountered. Try, try again. Three times. 🔁
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Only the good stuff. ✨
  • --session="" — Session configuration. Gotta stay logged in, bestie. 🔐
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled. For the rule-breakers. 🏴‍☠️
  • -P, --sessionPassword="" — Override session password. Shh, it's a secret. 🤫
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). Who you are matters. 👤
  • --silentExit[=false] — Silent status codes do not affect the exit code. Sometimes you just don't wanna hear it. 🤐
  • --silentStatusCodes="" — Status codes which will not print out an error message. No error message, no stress. 😌
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. Don't wait forever, bestie. ⏱️
  • --totalPages=0 — Total number of pages to get. How many pages do you want? Your call. 📄
  • -v, --verbose[=false] — Verbose logging. Say more, queen. 🗣️
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. Auto is the default — it just knows. 👀
  • --withError[=false] — Errors will be printed on stdout instead of stderr. For when you want errors to be part of the main character moment. 🎭
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Fancy. 📊
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Page count realness. 📄
  • --workers=1 — Number of workers. One is the default. Multitask if you want. 👩‍💻

🌈 EXAMPLE 🌈

Here's the moment you've been waiting for — a real-life example, bestie:

$ c8y alarms create --device 12345 --type c8y_TestAlarm --time "-0s" --text "Test alarm" --severity MAJOR

Create a new alarm for device. That's it. Slay. 💅

👑 SEE ALSO 👑

c8y-alarms(1) — because there's more where that came from. Go explore, bestie. 🦋

This page is from the c8y(1) manual, dated Jan 1980. Stay slay, stay secure, and don't forget to check your alarms. 💖✨🎀

📦 where this page comes from