c8y(1)

📦 version 2.56.1, in nixpkgs unstable

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

okay so bestie, welcome to c8y — the command-line bestie for Cumulocity. This particular page is about one very specific little icon: c8y-bulkoperations-listOperations. Yes that's a mouthful. Yes it's worth it. Let's go 🫶

✨ NAME ✨

c8y-bulkoperations-listOperations — literally just get the operations collection. That's the whole vibe. 💅

🦋 SYNOPSIS 🦋

c8y bulkoperations listOperations [flags]

🌸 DESCRIPTION 🌸

You know how a bulk operation has a whole swarm of little operations hanging off it? This is the command that goes and fetches that whole collection for you. One bulk op in, one big pile of related operations out. Iconic behavior, no notes. ✨

🎀 OPTIONS 🎀

  • --dateFrom="" — start date, or start date and time, of the operation. Leave it empty and you're just not filtering on it, nbd.
  • --dateTo="" — end date, or end date and time, of the operation. Same deal.
  • -h, --help[=false] — help for listOperations. Your emotional support flag. 🫶
  • --id=[] — the bulk operation id. This one is required, bestie, no cap. (also accepts pipeline ✨)
  • --revert[=false] — sort operations newest to oldest. Heads up: you must use this together with the dateFrom and/or dateTo parameters. It's not a solo act.
  • --status="" — the operation status, and it can be one of SUCCESSFUL, FAILED, EXECUTING or PENDING. Pick your fighter. ⭐

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these are the ones you get for free from the parent command, and there are... a lot of them. but they're all useful, i promise. let's get into it 🧚

  • --abortOnErrors=10 — abort the batch when you hit this 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 to the 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 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. chaotic energy, honestly.
  • --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. nothing actually happens, it's just a vibe check.
  • --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 you.
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. say that five times fast 😭
  • -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. all of them. every last one. 👑
  • -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! ⚠️ the manpage said caution, so i'm saying 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 the cache setting).
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. (sad but sometimes necessary)
  • --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 the 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 examples are lowkey the best part, watch this ✨

$ c8y bulkoperations listOperations --id 10 --status PENDING
Get a list of pending operations from bulk operation with id 10

grab a list of pending operations from the bulk operation with id 10. simple. clean. slay. 💅

$ c8y bulkoperations list --filter "status eq IN_PROGRESS" | c8y bulkoperations listOperations --status PENDING
Get all pending operations from all bulk operations which are still in progress (using pipeline)

pipeline moment!! 🦋 get all the pending operations from all bulk operations that are still in progress. the pipe is doing the heavy lifting and honestly? she's carrying the whole team.

$ c8y bulkoperations list | c8y bulkoperations listOperations --status EXECUTING --dateTo "-10d" | c8y operations update --status FAILED --failureReason "Manually cancelled stale operation"
Check all bulk operations if they have any related operations still in executing state and were created more than 10 days ago, then cancel it with a custom message

three commands, one pipeline, zero mercy. 🌈 this checks all bulk operations for related operations that are still in executing state and were created more than 10 days ago, then cancels them with a custom message. main character energy fr fr.

👀 SEE ALSO 👀

aaaand that's the page, bestie! 🎀 this was the c8y(1) manual — dated Jan 1980 (yes, really, 1980, she's vintage 💀) — hope it all made sense. go forth and list those operations. periodt. ✨💖

📦 where this page comes from