c8y(1)

📦 version 2.56.1, in nixpkgs unstable

✨ c8y(1) — your bestie's guide to the c8y command ✨

Hey bestie! 💖 This is the manual page for c8y(1), and I'm gonna walk you through the c8y-bulkoperations-update command like we're gossiping in the group chat. No cap, it's gonna be iconic. Let's go! 🫶

💖 NAME 💖

c8y-bulkoperations-update — the command that does Update bulk operation. Periodt. 💅

🦋 SYNOPSIS 🦋

Okay so here's the vibe check on how you run it:

c8y bulkoperations update [flags]

🌸 DESCRIPTION 🌸

So like, this command updates a bulk operation. But here's the tea: if you make an update on a bulk operation that's already started, it cancels that one and creates/schedules a new one. It's giving 'out with the old, in with the new' energy. 🔥

✨ OPTIONS ✨

  • --creationRampSec=0 — Delay between every operation creation. Default is 0, so no delay unless you set it. ⏳
  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'. So convenient! ✨
  • -h, --help[=false] — help for update. You know, the usual. 💁‍♀️
  • --id=[] — Bulk Operation id (required) (accepts pipeline). And yes, it's required! Don't forget it, bestie. 🚨
  • --processingMode="" — Cumulocity processing mode. Set it to whatever mode you need. 🌈
  • --template="" — Body template. For when you need a template for the body. 💌
  • --templateVars=[] — Body template variables. The vars that go with your template. 🎀

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. Default is 10. So if 10 errors happen, it's like 'nope, we're done'. 💀
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). It's false by default, so set it if you need that. 🙈
  • --cache[=false] — Enable cached responses. Off by default. Turn it on if you wanna cache. 🎀
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. So if you leave it empty, it's all values, bestie. 🦋
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. Default is 60s. Slay. ⏳
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. So if you're on a terminal, it's pretty by default. 💅
  • --confirm[=false] — Prompt for confirmation. Off by default. Use it if you want a little 'are you sure?' moment. 🤔
  • --confirmText="" — Custom confirmation text. For when you want your confirmation prompt to say something cute. 💬
  • --currentPage=0 — Current page which should be returned. Default is 0. Pagination vibes. 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. So you can add whatever params you need. 🔗
  • --debug[=false] — Set very verbose log messages. For when you wanna see everything. It's giving 'debug mode'. 🔍
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. Default is 0ms, so no delay. ⏱️
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Default is 0ms. Same energy as --delay but before. ⏳
  • --dry[=false] — Dry run. Don't send any data to the server. Perfect for when you're just testing. 🧪
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. Default is markdown. So you can see your dry run in different formats. 📝
  • --examples[=false] — Show examples for the current command. Off by default. Use it if you need inspo. ✨
  • --filter=[] — Apply a client side filter to response before returning it to the user. So you only see what you wanna see. 🎀
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. So nested stuff becomes dot notation. 🥞
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. So don't mix them up, bestie. 🚫
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". So you can add whatever headers you need. 📨
  • --includeAll[=false] — Include all results by iterating through each page. So you get everything. 📚
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. It's false by default. Only use if you know what you're doing, bestie. 🔓
  • -l, --logMessage="" — Add custom message to the activity log. For when you wanna leave a little note. 📝
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!).
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 it's not for every request. 🙃
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). So if you wanna be sure, use this. 🚫
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. For when you want it plain. 🎨
  • --noLog[=false] — Disables the activity log for the current command. So no log for this one. 📴
  • --noProgress[=false] — Disable progress bars. For when you don't want the little progress bar. 🚫
  • --noProxy[=false] — Ignore the proxy settings. So it won't use your proxy. 🌐
  • -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. Default is table. So you can pick your vibe. 📊
  • --outputFile="" — Save JSON output to file (after select/view). Note: it's after select/view. So it saves the final output. 💾
  • --outputFileRaw="" — Save raw response to file (before select/view). And this one is before select/view. So you get the raw stuff. 📁
  • --outputTemplate="" — jsonnet template to apply to the output. For when you wanna customize. 🎨
  • -p, --pageSize=5 — Maximum results per page. Default is 5. So five at a time. 📄
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. So it's a trade-off. 📊
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. Set it if you need a proxy. 🌐
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. So it's raw and json. 🔥
  • --retries=3 — Max number of attempts when a failed http call is encountered. Default is 3. So it'll try three times. 🔁
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. So you can pick exactly what you want. ✨
  • --session="" — Session configuration. For your session. 🎀
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled. So you can force it. 🔧
  • -P, --sessionPassword="" — Override session password. For when you need a different password. 🔑
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). So you can switch users. 👤
  • --silentExit[=false] — Silent status codes do not affect the exit code. So they won't change the exit code. 🤫
  • --silentStatusCodes="" — Status codes which will not print out an error message. So you can silence specific ones. 🔇
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. Default is 600s. So ten minutes. ⏰
  • --totalPages=0 — Total number of pages to get. Default is 0. So set it if you want a specific number. 📄
  • -v, --verbose[=false] — Verbose logging. For when you want all the details. 🗣️
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. Default is auto. So it's automatic by default. 👀
  • --withError[=false] — Errors will be printed on stdout instead of stderr. So they go to stdout. 📤
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). So if you're on that version or later, it's there. 📊
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. So you get total pages. 📄
  • --workers=1 — Number of workers. Default is 1. So one worker unless you change it. 👷‍♀️

🎀 EXAMPLE 🎀

Here's a little example to show you how it's done, bestie: 🎀

$ c8y bulkoperations update --id 12345 --creationRampSec 15
Update an bulk operation

👑 SEE ALSO 👑

Check out c8y-bulkoperations(1) for more bulk operation goodness. 👑

✨ And that's the tea, bestie! This page is from the c8y(1) manual, dated Jan 1980. Now go update those bulk operations like the icon you are! 🫶💖

📦 where this page comes from