c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the group chat guide

okay bestie so this is the manual for c8y (yes, the whole manual, page c8y(1)), and this particular page is all about one little command that pulls a single alarm. sit down, grab a boba, we're gonna go through every single flag together 🫶

✨ NAME ✨

c8y-alarms-get — get an alarm. that's it, that's the whole vibe. one alarm, by its id 🎀

🌸 SYNOPSIS 🌸

c8y alarms get [flags]

literally just that. command, subcommand, subsubcommand, and then flags if you're feeling fancy ✨

🦋 DESCRIPTION 🦋

Get an alarm by its id. one (1) alarm. singular. iconic behaviour honestly 👑

💖 OPTIONS 💖

  • -h, --help[=false] — help for get. the "wait what does this do again" button 🙈
  • --id=[] — Alarm id. this one's required (so like, you can't skip it, it's not optional, it's giving main character energy) and it accepts pipeline 🚰

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

okay so these aren't even this command's own flags, they're inherited from the parent commands, but they still work here so we're covering all of them. no skipping, no cap 💀

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors. ten strikes and it's out 🎳
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. empty pipe? we're chill about it 🧘
  • --cache[=false] — enable cached responses. memory queen behaviour 💾
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty means all values. so like, leave it empty and it hashes everything 🌈
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. how long the cache stays fresh before it expires ⏳
  • -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. are you sure bestie?? 🥺
  • --confirmText="" — custom confirmation text. write your own "are you sure" ✍️
  • --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. the "tell me EVERYTHING" mode 🗣️
  • --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. window shopping only 🛍️
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl 📝
  • --examples[=false] — show examples for the current command. show me how it's done 🙏
  • --filter=[] — apply a client side filter to response before returning it to the user. sift it before it reaches you 🫧
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. squish it flat 🔨
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. bold of you 💅
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" 📨
  • --includeAll[=false] — include all results by iterating through each page. give me EVERYTHING 🔁
  • -k, --insecure[=false] — allow insecure server connections when using SSL. living dangerously, we love a risk taker 😬
  • -l, --logMessage="" — add custom message to the activity log. leave a little note 🗒️
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). no cap, literally, but be careful fr fr ⚠️
  • --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). no memory for you ✋
  • -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. no receipts 🧾
  • --noProgress[=false] — disable progress bars. no little moving bar for us 😔
  • --noProxy[=false] — ignore the proxy settings. straight to the source 🛣️
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. respect the loop 🌀
  • -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. five at a time, cozy 🛋️
  • --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. no filter, no chill 🧊
  • --retries=3 — max number of attempts when a failed http call is encountered. three tries, then we're done ✋
  • --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. shhh 🤐
  • --silentStatusCodes="" — status codes which will not print out an error message 🔇
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. ten minutes of patience, then we go ⏰
  • --totalPages=0 — total number of pages to get 📚
  • -v, --verbose[=false] — verbose logging. talk to me 🗨️
  • --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. one little worker bee, unless you say otherwise 🐝

🔥 EXAMPLE 🔥

$ c8y alarms get --id 12345
Get alarm

look at her go. passing --id 12345 and getting the alarm. slay 💅

👑 SEE ALSO 👑

c8y-alarms(1) — the whole alarms family, go say hi 🫶

and that's the page bestie 💖 this one's from the c8y(1) manual, dated Jan 1980 (yes, really, that's the date on the footer, we don't question it 🌸), so go forth and fetch exactly one alarm at a time. periodt ✨🎀

📦 where this page comes from