c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the manual, but make it make sense

okay so this is the manual page for the c8y command (that's the manual name bestie, it's a c8y(1) situation, we love a numbered section) — and specifically we're zooming in on one little subcommand that is lowkey a whole lifesaver. sit down, grab a strawberry drink 🍓, let's get into it.

✨ NAME ✨

c8y-operations-wait — literally just wait for operation. that's it. that's the whole vibe. 🕐

🌸 SYNOPSIS 🌸

c8y operations wait [flags]

🦋 DESCRIPTION 🦋

wait for an operation to complete. iconic behaviour honestly — sometimes you just gotta sit there and let the operation cook. no cap. 🔥

🎀 OPTIONS 🎀

  • --duration="30s" — the timeout duration, aka how long you're willing to sit and wait before you give up. i.e. 30s or 1m (that's 1 minute, bestie, in case the math wasn't mathing) ⏳
  • -h, --help[=false] — help for wait. when in doubt, ask for help, it's giving self-care 💖
  • --id=[] — the operation id. required, so don't come crying to me when it yells at you. it also accepts pipeline 🚰
  • --status=[SUCCESSFUL] — the status you're waiting for. and here's the tea: if you give multiple values, it gets applied as an OR operation. so like, any of them. whichever hits first. periodt ✨

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the hand-me-downs from the parent command and honestly they ate. all of them. every single one 🫶

  • --abortOnErrors=10 — abort the batch when it reaches the specified number of errors. know when to walk away 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input is empty (stdin). be gentle with it 🙈
  • --cache[=false] — enable cached responses
  • --cacheBodyPaths=[] — the cache should limit hashing of selected paths in the json body. empty means 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 the 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. she's loud and we respect it 📢
  • --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
  • --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 a custom message to the activity log
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) ⚠️
  • --noAccept[=false] — ignore the Accept header. this 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 the cache setting)
  • -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
  • --noProgress[=false] — disable progress bars
  • --noProxy[=false] — ignore the proxy settings
  • -n, --nullInput[=false] — don't read the input (stdin). useful if you're using it 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. try, try, try again energy 💪
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
  • --session="" — session configuration
  • --sessionMode="" — override the 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 so here's where it gets good, actual receipts 🧾

$ c8y operations wait --id 1234
# Wait for the operation to be set to SUCCESSFUL
$ c8y operations wait --id 1234 --duration 1m
# Wait for the operation to be set to SUCCESSFUL and give up after 1 minute

and my personal fave, the pipeline combo — piped input plus multiple statuses, chef's kiss 👩‍🍳💋

$ c8y operations list --device 1111 | c8y operations wait --status "FAILED" --status "SUCCESSFUL"
# Wait for operation to be set to either FAILED or SUCCESSFUL

🧚 SEE ALSO 🧚

c8y-operations(1) — go read the parent, she's the main character, we're just her supporting cast 👑

tiny reminder bestie 💅 — --id is required for wait. the manual said it, not me. and if you stack multiple --status values it's an OR, not an AND. don't let anyone tell you otherwise ✨

that's the whole page! mwah 🫶 this one comes to you from the Jan 1980 release notes on the c8y(1) side of the manual — yes, Jan 1980, she's vintage and she's thriving, don't question it 💜

📦 where this page comes from