c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y-smartgroups-update — the c8y(1) manual page 💅

okay bestie, welcome to the c8y(1) manual page for updating a smart group. it's giving “tiny command, lots of inherited options” energy, and we're gonna get through every single one together. no cap. 🫶

🎀 NAME 🎀

c8y-smartgroups-update — Update smart group.

✨ SYNOPSIS ✨

c8y smartgroups update [flags]

🌸 DESCRIPTION 🌸

Update properties of an existing smart group. literally that's the whole vibe: you point it at a smart group and change its properties. 💖

🔥 OPTIONS 🔥

  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' — yes, shorthand json is lowkey iconic like that.
  • -h, --help[=false] — help for update. the “wait, what does this do again?” button. 🙈
  • --id=[] — Smart group ID (required) (accepts pipeline). it's required, bestie, so don't forget it. and yes, it accepts pipeline. 💅
  • --newName="" — New smart group name. rename your smart group, main character style. 👑
  • --processingMode="" — Cumulocity processing mode. exact setting, no extra lore. ✨
  • --query="" — New query. give the smart group a fresh query. 🦋
  • --template="" — Body template. template time. 🎀
  • --templateVars=[] — Body template variables. the little variables that go with the template. 🌈

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

these are the options it inherited from the parent commands — yes, all of them. stay with me, bestie. 💀

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. it bails after that many errors. ⚠️
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). empty pipe? not a problem when this is on. 🫶
  • --cache[=false] — Enable cached responses. cache girlies rise. 💖
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. so if it's empty, it's all values. okay? okay. ✨
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. it expires, periodt. ⏳
  • -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, --compact = compact. 💅
  • --confirm[=false] — Prompt for confirmation. it asks first, respectfully. 🙈
  • --confirmText="" — Custom confirmation text. your own confirmation message, your own vibe. 🎀
  • --currentPage=0 — Current page which should be returned. page number, starting at 0. 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. query param customization, slay. 🔥
  • --debug[=false] — Set very verbose log messages. very verbose. very demure. very mindful. 😭
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. tiny pause after each request. 🕰️
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. tiny pause before each request. 🕰️
  • --dry[=false] — Dry run. Don't send any data to the server. pretend mode: on. no data leaves the house. 🚪
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. pick your dry-run output format. 🌈
  • --examples[=false] — Show examples for the current command. examples, bestie! yes! 🍓
  • --filter=[] — Apply a client side filter to response before returning it to the user. client-side filter before it gets back to you. 🦋
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested json? flattened with dot notation. 🪄
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. no confirmation prompt. but if --confirm is in the mix, this one is ignored. ⚠️
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". custom headers, exactly like that. 💌
  • --includeAll[=false] — Include all results by iterating through each page. all results, all pages. 🔁
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. insecure SSL connections, use with awareness. 🔓
  • -l, --logMessage="" — Add custom message to the activity log. put your own message in the activity log. 🪵
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). unlimited jobs, but the manual itself says use with caution, so… caution, bestie. ⚠️
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. it removes the Accept header from requests, but PUT and POST requests will only see the effect. noted. 📝
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). no cache, forcibly, and it overwrites the cache setting. 💀
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. no colors for console log entries. monochrome moment. 🖤
  • --noLog[=false] — Disables the activity log for the current command. activity log: off for this command. 🚫
  • --noProgress[=false] — Disable progress bars. no progress bars. none. zero. 🙅
  • --noProxy[=false] — Ignore the proxy settings. proxy settings? ignored. 🫥
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. don't read stdin; useful in shell for/while loops. 🐚
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. default is table. pick your output. 📊
  • --outputFile="" — Save JSON output to file (after select/view). save JSON after select/view. 💾
  • --outputFileRaw="" — Save raw response to file (before select/view). save raw response before select/view. 🗂️
  • --outputTemplate="" — jsonnet template to apply to the output. jsonnet template, applied to the output. 🧚
  • -p, --pageSize=5 — Maximum results per page. default is 5. tiny page, cute page. 📄
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. progress bar on, other verbose output off. 📈
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. proxy goes here. 🌐
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. raw response mode forces output=json and view=off. periodt. 💅
  • --retries=3 — Max number of attempts when a failed http call is encountered. default 3 attempts when an http call fails. 🔁
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. pick exactly which properties come back. 🎯
  • --session="" — Session configuration. session config goes here. 🪪
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled. override the default session mode for a single command that would normally be disabled. 🫶
  • -P, --sessionPassword="" — Override session password. password override. 🤫
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). username override, tenant style included. 👤
  • --silentExit[=false] — Silent status codes do not affect the exit code. silent status codes don't touch the exit code. 🤐
  • --silentStatusCodes="" — Status codes which will not print out an error message. these status codes won't print an error message. 🔇
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. default is 600s, bestie. ⏱️
  • --totalPages=0 — Total number of pages to get. set the total pages you want. 📚
  • -v, --verbose[=false] — Verbose logging. talkative mode. 🗣️
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. default is auto; turn it off with --view off. 👀
  • --withError[=false] — Errors will be printed on stdout instead of stderr. errors to stdout instead of stderr. 🔀
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). exact path, exact version note. ✨
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. total pages under .statistics.totalPages. 📄
  • --workers=1 — Number of workers. default is 1. 🛠️

🍓 EXAMPLE 🍓

$ c8y smartgroups update --id 12345
Update smart group by id

🦋 SEE ALSO 🦋

c8y-smartgroups(1)

that's the whole page, bestie 💖 — straight from the c8y(1) manual, dated Jan 1980. mwah! 🎀✨

📦 where this page comes from