c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌸 c8y-devices-availability — Cumulocity device availability 🌸

Hey bestie! This is the page from the c8y(1) manual, all about device availability. Let's get into it! ✨

✨ SYNOPSIS ✨

c8y devices availability [flags]

💖 DESCRIPTION 💖

Okay so this is the REST endpoint to interact with Cumulocity devices. It's giving main character energy for sure! 💅

🎀 OPTIONS 🎀

Here are the options you can use with this command:

  • -h, --help[=false] — help for availability. Use this when you need a little help, bestie! 🫶

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

These are the options that trickle down from the parent commands. So many, but we got you! 🌈

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. Like, if things go wrong too many times, just stop, you know? 💀
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). No input? No problem! 🫶
  • --cache[=false] — Enable cached responses. Save those responses for later, slay! 💾
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. So if you leave it empty, it's literally all values. 🎀
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. How long the cache sticks around, bestie! ⏳
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. Keep it cute and compact! ✨
  • --confirm[=false] — Prompt for confirmation. Double-check before you commit, no cap! 🫶
  • --confirmText="" — Custom confirmation text. Make it your own! 💅
  • --currentPage=0 — Current page which should be returned. Page zero, let's go! 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Add your own vibes to the query! 🌈
  • --debug[=false] — Set very verbose log messages. For when you really need to see everything, bestie! 🔍
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. Chill for a sec after each request. 😴
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Chill for a sec before each request. 😴
  • --dry[=false] — Dry run. Don't send any data to the server. Just pretend, like a rehearsal! 🎭
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. Pick your fave format for the dry run! 🎀
  • --examples[=false] — Show examples for the current command. Examples are always a vibe! 📚
  • --filter=[] — Apply a client side filter to response before returning it to the user. Filter it out before you see it! 🌸
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. Flatten it like a pancake! 🥞
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. No confirmation needed, just go! 🔥
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". Add your own headers, bestie! 📨
  • --includeAll[=false] — Include all results by iterating through each page. Get every single result, no skips! 🌟
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. Living dangerously, huh? 😏
  • -l, --logMessage="" — Add custom message to the activity log. Leave a little note in the log! 📝
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). Unlimited jobs? Use with caution, bestie! ⚠️
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. Ignore that header, but only for PUT and POST! 🚫
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). No cache for you! 🚫
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. No colors, just plain text. 🎨
  • --noLog[=false] — Disables the activity log for the current command. No log, no problem! 🚫
  • --noProgress[=false] — Disable progress bars. No progress bars, just vibes. 🚫
  • --noProxy[=false] — Ignore the proxy settings. No proxy, straight to the server! 🚫
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. No input needed, perfect for loops! 🫶
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. Pick your output vibe! 📊
  • --outputFile="" — Save JSON output to file (after select/view). Save it for later! 💾
  • --outputFileRaw="" — Save raw response to file (before select/view). Save the raw stuff too! 💾
  • --outputTemplate="" — jsonnet template to apply to the output. Template it up! 🎨
  • -p, --pageSize=5 — Maximum results per page. Five per page, cute! 📄
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. Show that progress, but no other verbose vibes! 📊
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. Set your proxy, bestie! 🌐
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. Raw and unfiltered, just how you like it! 🔥
  • --retries=3 — Max number of attempts when a failed http call is encountered. Try, try again—three times max! 🔄
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Pick exactly what you want! 🎯
  • --session="" — Session configuration. Set up your session! 🫶
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled. Override it just this once! ✨
  • -P, --sessionPassword="" — Override session password. Password override, shh! 🔐
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). Username override, with or without tenant! 👤
  • --silentExit[=false] — Silent status codes do not affect the exit code. Silent but deadly—to the exit code, anyway! 🤫
  • --silentStatusCodes="" — Status codes which will not print out an error message. These codes stay quiet! 🤫
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. Wait up to ten minutes, bestie! ⏰
  • --totalPages=0 — Total number of pages to get. Get all the pages! 📚
  • -v, --verbose[=false] — Verbose logging. Tell me everything! 🗣️
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. Views on the terminal, auto-magically! ✨
  • --withError[=false] — Errors will be printed on stdout instead of stderr. Errors go to stdout now! 🚨
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Get those total elements, introduced in 10.13! 📊
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Total pages in the stats! 📄
  • --workers=1 — Number of workers. Just one worker by default, but you can add more! 👷

👑 SEE ALSO 👑

Don't forget to check out these other pages, bestie:

This page was brought to you by the c8y(1) manual, dated Jan 1980. Stay slay, bestie! 💖✨

📦 where this page comes from