c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — like, the c8y manual page, bestie

okay so real talk, this is the manual page for c8y, and specifically for one lil command in it that you're gonna be obsessed with. it's in section 1 of the manual (that's the (1) bit, iykyk), and honestly? it's giving "tiny command, huge friend group" because of all the options it inherited. buckle up 🎀

✨ NAME ✨

c8y-devices-availability-get — get device availability, no cap

🦋 SYNOPSIS 🦋

c8y devices availability get [flags]

🌸 DESCRIPTION 🌸

okay so picture this: you've got a specific managed object (you know, the thing you identify by a given ID), and you wanna know the date when it last sent a message to Cumulocity. that's it. that's the whole vibe. this command goes and retrieves that date for you. literally its whole personality 💖

👑 OPTIONS 👑

  • -h, --help[=false] — the help for get. your little "wait what does this do again" bestie 🫶
  • --id=[] — the Device. and yes it's required, so don't come crying to me when it yells at you. it accepts pipeline too, which is a slay ✨

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the options the parent commands passed down like the iconic family heirlooms they are. there are a LOT. hydrate before reading 💀

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. very forgiving, we love that
  • --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 — the 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 the 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!) ⚠️ like, genuinely, 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 🍓

look at these lil guys go, honestly iconic behavior:

$ c8y devices availability get --id 12345
Get a device's availability by id
$ c8y devices availability get --id device01
Get a device's availability by name
$ c8y devices get --id device01 --dry=false | c8y devices availability get
Get a device's availability using a pipeline

that last one?? pipeline queen. the way that | just works 🔥

🧚 SEE ALSO 🧚

💅 reminder bestie: --id is required, so don't skip it unless you enjoy the taste of error messages

okay that's the whole page!! and before I go — this beauty is dated Jan 1980 and comes from the c8y source/version, which is genuinely so funny to me but anyway, mwah, go get that availability, you got this 🦋✨💖

📦 where this page comes from