c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🎀 c8y — the c8y(1) manual, but make it make sense 🎀

okay so bestie, you're looking at the c8y manual page (yes, that's the manual name, we're folding it in right here at the top so it doesn't feel left out ✨). This particular page is all about the c8y-features-update command, and honestly? It's giving "small command, big glow-up" energy. Let's get into it 💅

🦋 NAME 🦋

c8y-features-update — Update tenant features 🌸

Like, that's the whole job. It updates features on your tenant. Iconic, lowkey, done.

✨ SYNOPSIS ✨

That's it. That's the whole vibe check. You run c8y features update and then you sprinkle flags on top like glitter 🎀

💖 DESCRIPTION 💖

Update tenant features 🫶

No cap, that's the description. Short, sweet, and to the point. The command does one thing and it does it well — main character energy fr fr.

👑 OPTIONS 👑

okay THIS is the part you actually came for, bestie. Every single flag, right here, no skipping, no summarizing, we don't do that here 💅

  • --active[=false] — Enable feature. Default is false, so it's off until you say otherwise ✨
  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' — so you can hand it a whole blob of json OR the cute shorthand version, your call 🍓
  • -h, --help[=false] — help for update. Your emergency "wait what does this do" button 🙈
  • --key="" — Feature ID / Key (required) (accepts pipeline). Yeah. It's required. Not optional. You literally cannot skip this one, bestie 😭 also it accepts pipeline, iykyk
  • --processingMode="" — Cumulocity processing mode 🌈
  • --template="" — Body template 🧚
  • --templateVars=[] — Body template variables 💜

🌸 OPTIONS INHERITED FROM PARENT COMMANDS 🌸

these are the flags you didn't ask for but got anyway — the whole fam showed up to the party 💀 and yes, we're listing every single one, because the original listed every single one and we are NOT about that skipping life 🫶

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors 🔥
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin) 🎀
  • --cache[=false] — Enable cached responses ⭐
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values 🦋
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m ⏳
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal ✨
  • --confirm[=false] — Prompt for confirmation 🙈
  • --confirmText="" — Custom confirmation text 💬
  • --currentPage=0 — Current page which should be returned 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' 🔗
  • --debug[=false] — Set very verbose log messages 🗣️
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s ⏱️
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s ⏱️
  • --dry[=false] — Dry run. Don't send any data to the server 🧪
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl 📝
  • --examples[=false] — Show examples for the current command 💡
  • --filter=[] — Apply a client side filter to response before returning it to the user 🔍
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation 🪄
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm 💪
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" 📬
  • --includeAll[=false] — Include all results by iterating through each page 📚
  • -k, --insecure[=false] — Allow insecure server connections when using SSL 🔓
  • -l, --logMessage="" — Add custom message to the activity log 🗒️
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!) — bestie they put the warning right there for a reason, heed it 😭
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect 🚫
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting) 🧊
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console 🎨
  • --noLog[=false] — Disables the activity log for the current command 🔕
  • --noProgress[=false] — Disable progress bars 📉
  • --noProxy[=false] — Ignore the proxy settings 🚪
  • -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 📊
  • --outputFile="" — Save JSON output to file (after select/view) 💾
  • --outputFileRaw="" — Save raw response to file (before select/view) 💾
  • --outputTemplate="" — jsonnet template to apply to the output 🧵
  • -p, --pageSize=5 — Maximum results per page 📄
  • --progress[=false] — Show progress bar. This will also disable any other verbose output 📈
  • --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 🥩
  • --retries=3 — Max number of attempts when a failed http call is encountered 🔄
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' 🎯
  • --session="" — Session configuration 🔑
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled 🎛️
  • -P, --sessionPassword="" — Override session password 🤫
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant) 👤
  • --silentExit[=false] — Silent status codes do not affect the exit code 🤐
  • --silentStatusCodes="" — Status codes which will not print out an error message 🤐
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m ⏰
  • --totalPages=0 — Total number of pages to get 📚
  • -v, --verbose[=false] — Verbose logging 🗣️
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off 👀
  • --withError[=false] — Errors will be printed on stdout instead of stderr 🔀
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (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 👷

💅 EXAMPLE 💅

bestie they gave us ONE example and honestly it ate:

$ c8y features update --key example --active
Enable a feature in the current tenant

Look at that. --key example, --active, boom — feature enabled in the current tenant. Periodt. 🔥

🌈 SEE ALSO 🌈

  • c8y-features(1) — go touch grass in the parent command's manual too, there's more where this came from 🌱
ok that's the whole page!! you made it to the end, I'm so proud of you 🥹💖

and that's a wrap on c8y(1) — standing on business, dated Jan 1980 (yes the date is vintage, we don't question the lore 💀), signed off with love from your favorite manual 🎀✨ bye bestie!! 🦋

📦 where this page comes from