c8y(1)

✨ NAME ✨

c8y-operations - Cumulocity operations

okay so welcome to the c8y(1) manual, bestie 💖 this is the corner for Cumulocity operations, and the vibe check is: it’s the c8y-operations command. periodt.

🦋 SYNOPSIS 🦋

c8y operations [flags]

Like, that’s the whole synopsis. [flags] is where all the options below go, iykyk.

🎀 DESCRIPTION 🎀

It’s the REST endpoint to interact with Cumulocity operations — literally that’s what the manpage says, and honestly it’s giving main character energy ✨. You interact with Cumulocity operations, and the flags below handle the rest 💅.

💅 OPTIONS 💅

• -h, --help[=false] — help for operations. Ask for help and it’s there 🫶.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

These are inherited from the parent command, bestie — yes, all of them are coming along for the ride 🎀.

• --abortOnErrors=10 — Abort batch when reaching specified number of errors. The flag as written is --abortOnErrors=10, so that’s the number in play 💀.
• --allowEmptyPipe[=false] — Don’t fail when piped input is empty (stdin). No empty-pipe meltdowns, bestie 🫶.
• --cache[=false] — Enable cached responses. Caching is on its way to being iconic 💖.
• --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty ([]) indicates all values. So yes, all the values, no cap 🧚.
• --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. The flag spells it "60s" out front ⏳.
• -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. So terminal gets the pretty treatment unless you say otherwise 💅.
• --confirm[=false] — Prompt for confirmation. A little “are you sure?” moment 🥺.
• --confirmText="" — Custom confirmation text. Make that prompt say what you want it to say 💬.
• --currentPage=0 — Current page which should be returned. The page number is 0 in the flag, and that’s the starting vibe 📄.
• --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Custom query param era, periodt 🔥.
• --debug[=false] — Set very verbose log messages. Debug mode is loud and proud 🔊.
• --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. The flag says "0ms" right there. After each request, take a breather ⏱️.
• --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Same breather, but before the request this time 🫧.
• --dry[=false] — Dry run. Don’t send any data to the server. It’s giving rehearsal, not the real performance 🎭.
• --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. The flag has "markdown" as written, bestie 📝.
• --examples[=false] — Show examples for the current command. Examples? Yes please, show me the receipts ✨.
• --filter=[] — Apply a client side filter to response before returning it to the user. Filter it client-side, then hand it over 🫶.
• --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. Flattening, but make it dot notation 💅.
• -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. Force is force, but --confirm gets priority, no cap ⚠️.
• -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". Bring your own headers to the function 🎀.
• --includeAll[=false] — Include all results by iterating through each page. All the pages, all the results, all the vibes 🔁.
• -k, --insecure[=false] — Allow insecure server connections when using SSL. Insecure mode is a choice, bestie — the flag says what it says 🔓.
• -l, --logMessage="" — Add custom message to the activity log. Put your own little note in the activity log ✍️.
• --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). The caution is literally in the manpage, so bestie, use with caution! 💀
• --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. So PUT and POST are the only ones catching this effect, iykyk 🚫.
• --noCache[=false] — Force disabling of cached responses (overwrites cache setting). No cache, even if cache said yes — it overwrites the cache setting 💥.
• -M, --noColor[=false] — Don’t use colors when displaying log entries on the console. Monochrome console log entries, if that’s your aesthetic 🖤.
• --noLog[=false] — Disables the activity log for the current command. No activity log for this command, periodt 🚫.
• --noProgress[=false] — Disable progress bars. No progress bars, no distractions 🛑.
• --noProxy[=false] — Ignore the proxy settings. Proxy settings? Ignored. Bye 👋.
• -n, --nullInput[=false] — Don’t read the input (stdin). Useful if using in shell for/while loops. No stdin reading, which is lowkey perfect for shell for/while loops 🌀.
• -o, --output="table" — Output format i.e. table, json, csv, csvheader. The flag is written with "table" as the output vibe 📊.
• --outputFile="" — Save JSON output to file (after select/view). JSON output goes to a file after select/view, fancy 💾.
• --outputFileRaw="" — Save raw response to file (before select/view). Raw response to a file before select/view — raw era 🗂️.
• --outputTemplate="" — jsonnet template to apply to the output. A jsonnet template for the output, go off 🧩.
• -p, --pageSize=5 — Maximum results per page. The page size is 5 right there in the flag 📚.
• --progress[=false] — Show progress bar. This will also disable any other verbose output. Progress bar on, other verbose output off — it’s a tradeoff, bestie 📈.
• --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. Set the proxy, example literally right there 🌐.
• -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. Raw response mode forces output=json and view=off, no cap 💀.
• --retries=3 — Max number of attempts when a failed http call is encountered. Max attempts: 3 in the flag, for when an http call fails 🔁.
• --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Select exactly what you want, wildcards and globstar included 🌟.
• --session="" — Session configuration. Session config, your little setup 🎟️.
• --sessionMode="" — Override default session mode for a single command which would normally be disabled. Override the default session mode for one command, even if it’s normally disabled — one-command exception 💅.
• -P, --sessionPassword="" — Override session password. Override the session password, shhh 🤫.
• -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). Override the session username; example is peter or t1234/peter with tenant 🪪.
• --silentExit[=false] — Silent status codes do not affect the exit code. Silent status codes stay out of the exit code’s business 🤐.
• --silentStatusCodes="" — Status codes which will not print out an error message. These status codes won’t print an error message — silence is golden 🤫.
• --timeout="600s" — Request timeout duration, i.e. 60s, 2m. The flag shows "600s", so that’s the timeout duration vibe ⏰.
• --totalPages=0 — Total number of pages to get. Total pages: 0 in the flag, get that many pages 📖.
• -v, --verbose[=false] — Verbose logging. Verbose logging, loud and proud 🗣️.
• --view="auto" — Use views when displaying data on the terminal. Disable using --view off. Views on the terminal by default; disable with --view off — the flag says "auto" 👀.
• --withError[=false] — Errors will be printed on stdout instead of stderr. Errors go to stdout instead of stderr, switch it up 🚨.
• --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Total elements in response stats, under .statistics.totalElements, introduced in 10.13 — noted, bestie 📊.
• -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Total pages in response stats under .statistics.totalPages — yes ma’am 📄.
• --workers=1 — Number of workers. Workers: 1 in the flag, that’s the worker count 🛠️.

🔥 SEE ALSO 🔥

c8y(1), c8y-operations-assert(1), c8y-operations-cancel(1), c8y-operations-create(1), c8y-operations-deleteCollection(1), c8y-operations-get(1), c8y-operations-list(1), c8y-operations-subscribe(1), c8y-operations-update(1), c8y-operations-wait(1)

okay bye bestie — this was the c8y(1) manual, dated Jan 1980, and it ate 💅✨🎀