c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y — the c8y manual, but make it make sense

okay so bestie, welcome to the c8y(1) page 💖 this is the one about setting a device's required availability, and ngl it's lowkey iconic. grab a snack, we're doing this together 🫶

✨ NAME ✨

c8y-devices-availability-set — set required availability. that's literally it, that's the whole vibe 🎀

✨ SYNOPSIS ✨

c8y devices availability set [flags]

🦋 DESCRIPTION 🦋

okay so here's the tea, bestie 🍵 you're setting the required availability of a device. Devices that haven't sent any message within the response interval? Yeah, they're considered unavailable 💀

The response interval can have a value between -32768 and 32767, and any values out of range get shrink to the range borders (yes, that's how it works, don't come for me). Those devices get marked as unavailable (see below 👇) and an unavailability alarm is raised 🔥

Devices with a response interval of zero minutes are considered to be under maintenance 🛠️ and no alarm is raised while a device is under maintenance — she's resting, leave her alone ✋

Devices that do not contain c8y_RequiredAvailability are not monitored. periodt. 🙈

💅 OPTIONS 💅

  • -h, --help[=false] — help for set. the classic "what does this even do" button 💫
  • --id=[] — Device ID (required) (accepts pipeline) 🆔
  • --interval=0 — Interval in minutes (required) ⏰
  • --processingMode="" — Cumulocity processing mode 🌀

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

okay these ones aren't hers originally, she inherited them from her parent commands, but they still show up to the party 💜

  • --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 🔓 (she's brave, okay)
  • -l, --logMessage="" — Add custom message to the activity log 🗒️
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!) ⚠️ like fr fr, be careful
  • --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 🌸

okay these are the examples, they're literally so good, look:

$ c8y devices availability set --id 12345 --interval 10
Set the required availability of a device by name to 10 minutes

$ c8y devices get --id device01 --dry=false | c8y devices availability set --interval 10
Set the required availability for a device using pipeline

$ c8y devices list | c8y devices availability set --interval 10
Set the required availability for a list of devices using pipeline

like, the pipeline ones? chef's kiss 👨‍🍳💋 she ate and left no crumbs 🔥

👑 SEE ALSO 👑

c8y-devices-availability(1) — go read her too, she's the sibling, iykyk 💖

aaaand that's the page bestie 🦋 she's giving very much "I know what I'm doing and I want you to know too" main character energy ⭐

signing off cutely: this was the c8y page, dated Jan 1980 — yeah, vintage, iconic, timeless 🎀 ily, go set some availabilities 💜

📦 where this page comes from