c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸ’… c8y(1) β€” the c8y manual page, but make it make sense πŸŽ€

okay bestie, welcome to c8y β€” yes, the manual is literally called c8y(1), we're all just living in its world ✨ and this page right here is c8y-operations-get, the little icon that fetches you one single operation. honestly? underrated. let's get into it 🫢


🌸 NAME 🌸

c8y-operations-get β€” Get operation πŸ’– like, go get it. grab that operation. that's the whole job.


✨ SYNOPSIS ✨

c8y operations get [flags]

that's it, that's the vibe. c8y, then operations, then get, then whatever flags your heart desires πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

Get an existing operation πŸŽ€

no cap, that's the description. you have an operation that already exists, and this command? this command goes and gets it. main character energy fr fr πŸ‘‘


πŸ’… OPTIONS πŸ’…

  • -h, --help[=false] β€” help for get πŸ₯Ί the little "what does this even do" button. defaults to false, as help flags do.
  • --id=[] β€” Operation id (required) (accepts pipeline) πŸ”₯ required, bestie, do not forget it. it also accepts pipeline input, so you can pipe that id in like the tech-savvy icon you are.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these aren't even get's own flags, they're inherited from the parent commands β€” the family traits, iykyk πŸ§¬πŸ’œ but they absolutely still work here, so let's go through all of them, no skipping, we're not that kind of girl πŸ™ˆ

  • --abortOnErrors=10 β€” Abort batch when reaching specified number of errors πŸ’€ hits 10 errors and it's out, bye.
  • --allowEmptyPipe[=false] β€” Don't fail when piped input is empty (stdin) 😌 empty pipe? not a crisis. defaults to false.
  • --cache[=false] β€” Enable cached responses ⭐ caching on.
  • --cacheBodyPaths=[] β€” Cache should limit hashing of selected paths in the json body. Empty indicates all values πŸ“ so like, if it's empty, everything gets hashed. all values. the whole buffet.
  • --cacheTTL="60s" β€” Cache time-to-live (TTL) as a duration, i.e. 60s, 2m ⏳ defaults to "60s".
  • -c, --compact[=false] β€” Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal ✨ terminal = pretty by default, so this one's for the gremlins who want it squished πŸ’…
  • --confirm[=false] β€” Prompt for confirmation πŸ™‹β€β™€οΈ it will ask. it will make sure.
  • --confirmText="" β€” Custom confirmation text πŸ’¬ write your own dramatic prompt, default is empty string.
  • --currentPage=0 β€” Current page which should be returned πŸ“„ starts at 0.
  • --customQueryParam=[] β€” add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' πŸ”— exact syntax, don't come for me.
  • --debug[=false] β€” Set very verbose log messages πŸ—£οΈ very verbose. VERY. buckle up.
  • --delay="0ms" β€” delay after each request, i.e. 5ms, 1.2s ⏱️ default "0ms".
  • --delayBefore="0ms" β€” delay before each request, i.e. 5ms, 1.2s ⏱️ also default "0ms". yes there's a before one AND an after one. both slay.
  • --dry[=false] β€” Dry run. Don't send any data to the server 🚫 nothing leaves the building.
  • --dryFormat="markdown" β€” Dry run output format. i.e. json, dump, markdown or curl πŸ“ default is "markdown", and yes curl is an option, iconic.
  • --examples[=false] β€” Show examples for the current command 🌟
  • --filter=[] β€” Apply a client side filter to response before returning it to the user 🧚 client side, meaning it happens on your machine before it gets handed to you.
  • --flatten[=false] β€” flatten json output by replacing nested json properties with properties where their names are represented by dot notation πŸͺ„ nested goes flat, dots go everywhere.
  • -f, --force[=false] β€” Do not prompt for confirmation. Ignored when using --confirm ⚠️ and heads up: --confirm wins. always.
  • -H, --header=[] β€” custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" πŸ“¨
  • --includeAll[=false] β€” Include all results by iterating through each page πŸ” every page, bestie, we're going through all of them.
  • -k, --insecure[=false] β€” Allow insecure server connections when using SSL πŸ™ˆ look away from the certificate, look awayβ€”
  • -l, --logMessage="" β€” Add custom message to the activity log πŸ““ default "".
  • --maxJobs=0 β€” Maximum number of jobs. 0 = unlimited (use with caution!) πŸ”₯⚠️ genuinely, the manpage says use with caution, so like… caution. 0 means unlimited and unlimited means chaos.
  • --noAccept[=false] β€” Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect 🫠 so the header gets yeeted, but only PUT and POST actually notice.
  • --noCache[=false] β€” Force disabling of cached responses (overwrites cache setting) πŸ’₯ it overrides --cache. no caching. periodt.
  • -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 πŸ“Š gone. no bar.
  • --noProxy[=false] β€” Ignore the proxy settings πŸšͺ pretend the proxy doesn't exist.
  • -n, --nullInput[=false] β€” Don't read the input (stdin). Useful if using in shell for/while loops πŸ”„ ok this one's lowkey a lifesaver in loops.
  • -o, --output="table" β€” Output format i.e. table, json, csv, csvheader πŸ“Š default is "table".
  • --outputFile="" β€” Save JSON output to file (after select/view) πŸ’Ύ after select/view, note that.
  • --outputFileRaw="" β€” Save raw response to file (before select/view) πŸ’Ύ and this one's before select/view. very different, don't mix them up.
  • --outputTemplate="" β€” jsonnet template to apply to the output 🧩
  • -p, --pageSize=5 β€” Maximum results per page πŸ“„ default 5.
  • --progress[=false] β€” Show progress bar. This will also disable any other verbose output πŸ“ˆ and yes it kills the other verbose output, that's the trade.
  • --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 πŸ₯© raw. it also forcibly sets output=json and view=off whether you like it or not.
  • --retries=3 β€” Max number of attempts when a failed http call is encountered πŸ” default 3. it will try, try, try again.
  • --select=[] β€” Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' 🎯 globstar girlies rise.
  • --session="" β€” Session configuration πŸ”
  • --sessionMode="" β€” Override default session mode for a single command which would normally be disabled πŸŽ›οΈ single command only, and it overrides a default that would normally be off.
  • -P, --sessionPassword="" β€” Override session password πŸ”‘
  • -U, --sessionUsername="" β€” Override session username. i.e. peter or t1234/peter (with tenant) πŸͺͺ either bare like peter or with the tenant like t1234/peter.
  • --silentExit[=false] β€” Silent status codes do not affect the exit code 🀫 quiet codes stay quiet.
  • --silentStatusCodes="" β€” Status codes which will not print out an error message 🀐 list them here and they'll hush.
  • --timeout="600s" β€” Request timeout duration, i.e. 60s, 2m ⏰ default "600s".
  • --totalPages=0 β€” Total number of pages to get πŸ“š starts at 0.
  • -v, --verbose[=false] β€” Verbose logging πŸ—£οΈ
  • --view="auto" β€” Use views when displaying data on the terminal. Disable using --view off πŸ‘€ default "auto".
  • --withError[=false] β€” Errors will be printed on stdout instead of stderr πŸ”€ stdout, not stderr. flip it.
  • --withTotalElements[=false] β€” Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13) πŸ”’ note the version: 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 πŸ‘·β€β™€οΈ default 1.

πŸ“ EXAMPLE πŸ“

$ c8y operations get --id 12345
Get operation by id

look at her go πŸ˜­πŸ’– clean, simple, --id 12345, operation acquired. slay.


πŸ”₯ SEE ALSO πŸ”₯

c8y-operations(1) β€” go meet the whole operations family, they're lovely 🫢


and that's the page, bestie!! πŸŽ€ shoutout to the manual itself β€” that's c8y(1), dated Jan 1980 (yes, literally, that's the date on the footer, we don't question it πŸ•°οΈπŸ’€). mwah, go get those operations πŸ’œβœ¨

πŸ“¦ where this page comes from