c8y(1)

📦 version 2.56.1, in nixpkgs unstable

✨ c8y(1) — the manual, but make it cute ✨

Okay bestie, so this is the c8y manual page — like, the whole thing, bestie, I'm not skipping a single flag. We're talking c8y-datahub-jobs-get(1) energy, the Dremio job status checker, and it's giving "I need to know what my query is doing" realness. Let's get into it. 💅

🌸 NAME 🌸

c8y-datahub-jobs-get — Retrieve the status of a query job

Like, literally, it gets the status of a query job. That's the whole vibe. 🎀

✨ SYNOPSIS ✨

c8y datahub jobs get [flags]

That's it. That's the whole synopsis. Cute, right? 🦋

💖 DESCRIPTION 💖

So, bestie, here's the tea: you give this command the ID of the Dremio job that's executing your query, and it tells you the status. That's it. That's the whole description. No cap. It's literally just "Retrieve the status of a query given the ID of the Dremio job executing the query." Iconic behavior, honestly. ✨

🎀 OPTIONS 🎀

Okay so here's where it gets real. Every single flag, every default, every little detail — I got you. No summaries, no skips. Periodt. 💅

  • -h, --help[=false] — help for get. Like, it shows you the help. Default is false, obviously.
  • --id="" — The unique identifier of a Dremio job. This one is required (yes, bestie, you must provide it), and it accepts pipeline. Default is empty string "". Don't forget it or it's giving error energy. 🚨

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

These are the flags you get from the parent commands. Like, they're inherited, bestie. They come from up the chain. And yes, I'm listing every single one. All of them. No skips. 🫶

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. Default is 10. Like, if you hit 10 errors, it's done. Bye. 💀
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). Default false. So if your pipe is empty, it won't throw a fit. Nice.
  • --cache[=false] — Enable cached responses. Default false. Caching, but make it optional.
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. Default is []. So like, if you leave it empty, it hashes everything. 🧚
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. Default is "60s". So your cache lives for 60 seconds by default. Slay.
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. Default false. So if you want that compact json, hit this flag. 🎀
  • --confirm[=false] — Prompt for confirmation. Default false. Like, it asks you "are you sure?" before doing the thing.
  • --confirmText="" — Custom confirmation text. Default is empty string "". So you can make your own "are you sure?" message. Personalized confirmation, we love to see it. 💖
  • --currentPage=0 — Current page which should be returned. Default 0. Pagination, bestie.
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Default is []. So you can add your own query params. Custom, custom, custom. ✨
  • --debug[=false] — Set very verbose log messages. Default false. Debug mode: on. Very verbose. Much log. Wow.
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. Default "0ms". So like, a little pause after each request. Chill vibes.
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Default "0ms". A little pause before each request. Equally chill.
  • --dry[=false] — Dry run. Don't send any data to the server. Default false. So it's like, pretending. A rehearsal. No actual data sent. 🎭
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. Default is "markdown". So your dry run can be json, dump, markdown, or curl. Pick your fighter. 💅
  • --examples[=false] — Show examples for the current command. Default false. Like, it shows you examples. Helpful bestie behavior.
  • --filter=[] — Apply a client side filter to response before returning it to the user. Default []. So you can filter the response on your end. Client side filter, we stan. 🦋
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. Default false. So nested json gets flattened with dot notation. Like a.b.c instead of {a: {b: {c: ...}}}. Iconic. ✨
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. Default false. So like, no confirmation prompt. But if you use --confirm, this flag is ignored. Noted. 📝
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". Default []. Custom headers, bestie. You can set multiple. 🎀
  • --includeAll[=false] — Include all results by iterating through each page. Default false. So it goes through every page and includes all the results. All of them. No cap.
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. Default false. Like, it's insecure, but make it optional. ⚠️
  • -l, --logMessage="" — Add custom message to the activity log. Default is empty string "". So you can add your own little note to the log. Personalized logging, we love. 💖
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). Default 0. So zero means unlimited, but like, the manpage literally says "use with caution!" so maybe don't go wild, bestie. 🔥
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. Default false. So it removes the Accept header, but only PUT and POST requests actually see that effect. Note the caveat. 📌
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). Default false. So like, it overrides the cache setting and forces no cache. Bye cache. 💀
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. Default false. So no colors in the log. Monochrome vibes.
  • --noLog[=false] — Disables the activity log for the current command. Default false. So no activity log for this command. Silenced.
  • --noProgress[=false] — Disable progress bars. Default false. No progress bars. No little spinners. Just silence. 🦋
  • --noProxy[=false] — Ignore the proxy settings. Default false. So it ignores proxy settings. Bypass the proxy. 🚪
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. Default false. So it doesn't read stdin. Perfect for shell loops. Loop-friendly, we stan. 🔁
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. Default is "table". So you can output as table, json, csv, or csvheader. Pick your format. 💅
  • --outputFile="" — Save JSON output to file (after select/view). Default is empty string "". So it saves the JSON output to a file after select/view. File save, cute. 📁
  • --outputFileRaw="" — Save raw response to file (before select/view). Default is empty string "". So it saves the raw response to a file before select/view. Raw, untouched, pure. 🧚
  • --outputTemplate="" — jsonnet template to apply to the output. Default is empty string "". So you can apply a jsonnet template. Template time. ✨
  • -p, --pageSize=5 — Maximum results per page. Default 5. So like, five results per page. Small and cute. 🎀
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. Default false. So progress bar on, but verbose output off. Trade-off, bestie. ⚖️
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. Default is empty string "". So you can set a proxy. Like http://10.0.0.1:8080. Go through the proxy. 🚪
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. Default false. So raw response mode forces json output and turns view off. Raw and unfiltered. 💀
  • --retries=3 — Max number of attempts when a failed http call is encountered. Default 3. So three attempts. Three strikes. Then it's done. 🔁
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Default []. So you can select specific properties. Wildcards and globstar accepted. Select your faves. ⭐
  • --session="" — Session configuration. Default is empty string "". Session config, whatever that means. It's a thing.
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled. Default is empty string "". So it overrides the session mode for one command. One-time override. 🎀
  • -P, --sessionPassword="" — Override session password. Default is empty string "". So you can override the session password. Secret password, bestie. 🔐
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). Default is empty string "". So you can override the username, with or without tenant. Username realness. 💅
  • --silentExit[=false] — Silent status codes do not affect the exit code. Default false. So silent status codes don't change the exit code. Silent but deadly.
  • --silentStatusCodes="" — Status codes which will not print out an error message. Default is empty string "". So these status codes stay quiet. No error message. 🤫
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. Default is "600s". So ten minutes by default. That's a long timeout. Patience, bestie. ⏳
  • --totalPages=0 — Total number of pages to get. Default 0. So zero pages by default, which like, means all of them? Or none? It's 0. That's the default. 📄
  • -v, --verbose[=false] — Verbose logging. Default false. So verbose logging on. Lots of words. Very detailed. 🗣️
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. Default is "auto". So views on the terminal, auto by default. Disable with --view off. 👀
  • --withError[=false] — Errors will be printed on stdout instead of stderr. Default false. So errors go to stdout instead of stderr. Error relocation. 🚨
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Default false. So it asks Cumulocity for total elements. Introduced in 10.13, noted. 📊
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Default false. So it asks for total pages. Under .statistics.totalPages. Pagination realness. 📄
  • --workers=1 — Number of workers. Default 1. So one worker by default. One little worker bee. 🐝

💅 EXAMPLE 💅

Okay so here's the example, bestie. Copy it exactly. No typos. It's giving "retrieve a datahub job" energy. 🎀

$ c8y datahub jobs get --id "22feee74-875a-561c-5508-04114bdda000"
Retrieve a datahub job

That's it. That's the example. The ID is 22feee74-875a-561c-5508-04114bdda000 and it retrieves a datahub job. Slay. ✨

🌈 SEE ALSO 🌈

Like, go check out the parent command. It's the whole datahub jobs situation. You'll love it. 🫶

And that's the whole page, bestie! No skips, no summaries, every single flag and default and caveat is here. You're welcome. 💖

Oh, and before I forget — this manual page is giving Jan 1980 energy (yes, that's the date on it, don't ask) and it's from c8y(1). So like, vintage but make it current. Periodt. 💅✨

📦 where this page comes from