c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y — Cumulocity DataHub Jobs (yeah, the c8y(1) girlies know)

Okay so bestie, welcome to c8y — the Cumulocity CLI, and specifically the DataHub Jobs corner of it. This page is your whole guide. Buckle up, it's giving very thorough manual energy, but make it cute. 🎀

✨ NAME ✨

c8y-datahub-jobs — Cumulocity DataHub Jobs. That's the whole vibe. Jobs. In the DataHub. Slay. 💅

🌸 SYNOPSIS 🌸

c8y datahub jobs [flags]

That's it. That's the incantation. Type it, add some flags if you're feeling spicy, and go off. ✨

💖 DESCRIPTION 💖

It's Cumulocity DataHub Jobs, bestie. Literally the job-handling part of the DataHub, living under the c8y datahub family. Not me explaining the entire universe in one line, but here we are. 🫶

🦋 OPTIONS 🦋

  • -h, --help[=false] — shows you the help for jobs. Your lil emergency "wait what does this do again" button. 💖

🔥 OPTIONS INHERITED FROM PARENT COMMANDS 🔥

Okay so this is the big one — all of these come from the parent commands, like a whole inheritance situation, main character energy from the top of the tree. 🎀

  • --abortOnErrors=10 — bails the whole batch once it hits the specified number of errors. Drama queen behaviour and honestly same.
  • --allowEmptyPipe[=false] — tells it not to fail when the piped input (stdin) is empty. Empty pipe? No problem, no cap. 🫶
  • --cache[=false] — turns on cached responses.
  • --cacheBodyPaths=[] — limits the cache hashing to selected paths inside the json body. Empty means all the values get hashed, so like, everything. 💀
  • --cacheTTL="60s" — the cache time-to-live (TTL), written as a duration, i.e. 60s, 2m.
  • -c, --compact[=false] — compact instead of pretty-printed output when you're using json output. Pretty print is the default if the output is the terminal, iykyk.
  • --confirm[=false] — prompts you for confirmation. Consent era. ✨
  • --confirmText="" — your own custom confirmation text, for when the default just isn't you.
  • --currentPage=0 — the current page that should be returned.
  • --customQueryParam=[] — adds custom URL query parameters, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Very glue-your-own-stuff-on energy.
  • --debug[=false] — sets very verbose log messages. Like, it will not stop talking. 😭
  • --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. It doesn't send any data to the server. Fake it till you make it, but like, safely. 🙈
  • --dryFormat="markdown" — the dry run output format, i.e. json, dump, markdown or curl.
  • --examples[=false] — shows examples for the current command. Iconic behaviour honestly.
  • --filter=[] — applies a client side filter to the response before it gets handed back to you. 🎀
  • --flatten[=false] — flattens json output by replacing nested json properties with properties where their names are represented by dot notation. Nesting? Gone. Flattened. Slay.
  • -f, --force[=false] — do not prompt for confirmation. It gets ignored when you're using --confirm, so pick a lane bestie.
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue".
  • --includeAll[=false] — includes all results by iterating through each page. All of them. Every single one. 💖
  • -k, --insecure[=false] — allows insecure server connections when using SSL. Dramatic, risky, but it's your life. 💀
  • -l, --logMessage="" — adds a custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited, and the original literally says use with caution! so like, noted. ⚠️
  • --noAccept[=false] — ignore the Accept header; this removes the Accept header from requests, however PUT and POST requests will only see the effect. Yep, only those. 🫠
  • --noCache[=false] — forces disabling of cached responses (and it overwrites the cache setting, so it wins the argument).
  • -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] — disables progress bars.
  • --noProxy[=false] — ignores the proxy settings.
  • -n, --nullInput[=false] — don't read the input (stdin). Super useful if you're using it in shell for/while loops. 🌀
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader.
  • --outputFile="" — saves JSON output to a file (after select/view).
  • --outputFileRaw="" — saves the raw response to a file (before select/view).
  • --outputTemplate="" — a jsonnet template to apply to the output. Fancy. ✨
  • -p, --pageSize=5 — maximum results per page.
  • --progress[=false] — shows the progress bar. Heads up: this will also disable any other verbose output. Sacrifices were made. 😭
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080.
  • -r, --raw[=false] — shows the raw response. This mode will force output=json and view=off, no negotiating.
  • --retries=3 — max number of attempts when a failed http call is encountered. Try again energy. 🔁
  • --select=[] — comma separated list of properties to return. Wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Iconic.
  • --session="" — session configuration.
  • --sessionMode="" — override the default session mode for a single command, which would normally be disabled.
  • -P, --sessionPassword="" — override the session password.
  • -U, --sessionUsername="" — override the 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. Shhh. 🤫
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m.
  • --totalPages=0 — total number of pages to get.
  • -v, --verbose[=false] — verbose logging. It's gonna tell you things. 💬
  • --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. Plot twist.
  • --withTotalElements[=false] — requests Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). ✨
  • -t, --withTotalPages[=false] — requests Cumulocity to include the total pages in the response statistics under .statistics.totalPages.
  • --workers=1 — number of workers. Bring friends. 👑

🌈 SEE ALSO 🌈

Go read these next, bestie, they're the whole friend group:

Lowkey reminder: this whole thing is a Cumulocity CLI joint, and the page is stamped c8y(1) with a date of Jan 1980. Yeah. 1980. She's been that girl for decades. 💅👑

Anyway, that's the manual, go run c8y datahub jobs and be iconic about it. 💖🦋🎀

📦 where this page comes from