c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the tenantOptions glow-up, bestie edition

okay so you're looking at the c8y manual page, specifically the tenantoptions command, and honestly? it's giving "powerful but nobody told me what it does" energy. don't worry, i got you. this is the whole page, every flag, every default, no cap. read it, love it, use it. 🫶

✨ NAME ✨

c8y-tenantoptions — Cumulocity tenantOptions, aka the place where your tenant's config lives. it's literally in the name, periodt.

✨ SYNOPSIS ✨

c8y tenantoptions [flags]

that's it. that's the whole vibe. you run c8y tenantoptions and then you throw flags at it like confetti. 🎀

✨ DESCRIPTION ✨

so this is a REST endpoint for interacting with Cumulocity tenantOptions. and what are those, you ask? options are category-key-value tuples that store your tenant configuration. think of it like a little filing cabinet: category is the drawer, key is the folder, value is the thing inside. 🗂️

some categories of options let you create new ones (yay, freedom ✨), but others are limited to a predefined set of keys — so no, you can't just invent new keys in those, bestie, it's not that kind of party. 💀

and here's the dramatic part: any option of any tenant can be defined as "non-editable" by the "management" tenant. after that, any PUT or DELETE requests made on that option by the owner tenant will result in a 403 error (Unauthorized). so the management tenant can lock the door and you're just standing there like 😭. respect the lock, fr fr.

✨ OPTIONS ✨

  • -h, --help[=false] — help for tenantoptions. the classic "what does this even do" button. use it, it's free. 💖

✨ OPTIONS INHERITED FROM PARENT COMMANDS ✨

these are the flags you get from the parent c8y command — think of them as the family heirlooms, the shared group-chat lore. you don't have to use them all, but they're all here. 🔥

  • --abortOnErrors=10 — abort batch when reaching specified number of errors. like a "three strikes" rule but you set the number. 💀
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe? not the end of the world, apparently. 🫶
  • --cache[=false] — enable cached responses. speed things up, you know the vibe. ⚡
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty indicates all values. so you can be picky about what gets cached. 🎯
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. how long the cache stays fresh before it expires. 🕐
  • -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 like your json messy, this is your flag. 🌸
  • --confirm[=false] — prompt for confirmation. safety first, bestie. 🛑
  • --confirmText="" — custom confirmation text. personalize your "are you sure?" moment. 💬
  • --currentPage=0 — current page which should be returned. for when you're deep in the pages. 📖
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. custom params, custom problems, custom solutions. ✨
  • --debug[=false] — set very verbose log messages. all the tea, all the details. 🐸☕
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. sometimes you just need a little pause between requests. ✋
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. warm-up before you go. 🏁
  • --dry[=false] — dry run. don't send any data to the server. all the planning, none of the commitment. 💅
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl. pick your aesthetic. 🎨
  • --examples[=false] — show examples for the current command. show me how it's done, king. 👑
  • --filter=[] — apply a client side filter to response before returning it to the user. you get to be the gatekeeper. 🚪
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested json? not on my watch. 🪄
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. bold move, bestie. do it. 🔥
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". headers on headers on headers. 📨
  • --includeAll[=false] — include all results by iterating through each page. collect the whole set, no pages left behind. 🗃️
  • -k, --insecure[=false] — allow insecure server connections when using SSL. dangerous? kinda. convenient? also yes. 🙈
  • -l, --logMessage="" — add custom message to the activity log. leave your mark on the logs. ✍️
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). unlimited power, unlimited chaos. be careful, bestie. 💀
  • --noAccept[=false] — ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. nuanced, honestly. 🔍
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). cache off, fresh answers only. 🚫
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome mode, very minimalist. 🖤
  • --noLog[=false] — disables the activity log for the current command. no receipts, no evidence. 🫣
  • --noProgress[=false] — disable progress bars. no bar, no stress. 🚫
  • --noProxy[=false] — ignore the proxy settings. go direct, no middleman. 🛣️
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. silent mode for your input. 🤫
  • -o, --output="table" — output format i.e. table, json, csv, csvheader. choose your aesthetic, bestie. 📊
  • --outputFile="" — save JSON output to file (after select/view). the polished, post-processed version. 📁
  • --outputFileRaw="" — save raw response to file (before select/view). the unedited director's cut. 🎬
  • --outputTemplate="" — jsonnet template to apply to the output. for when you want it exactly your way. 🎨
  • -p, --pageSize=5 — maximum results per page. small bites, manageable vibes. 🍰
  • --progress[=false] — show progress bar. this will also disable any other verbose output. progress bar says "i got this". 📈
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. route it through your proxy bestie. 🌐
  • -r, --raw[=false] — show raw response. this mode will force output=json and view=off. raw, unfiltered, no edits. 💅
  • --retries=3 — max number of attempts when a failed http call is encountered. try again, try again, try again. three times. 🔁
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. choose what you want. ✨
  • --session="" — session configuration. the session setup, the whole situation. 🔐
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. one-command override, very specific, very iconic. 💅
  • -P, --sessionPassword="" — override session password. secret secrets. 🔑
  • -U, --sessionUsername="" — override session username. i.e. peter or t1234/peter (with tenant). identity is a spectrum. 🎭
  • --silentExit[=false] — silent status codes do not affect the exit code. keep the exit code neutral, no drama. 🫥
  • --silentStatusCodes="" — status codes which will not print out an error message. not every error needs a speech. 🤐
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. patience has a limit, and this is it. ⏳
  • --totalPages=0 — total number of pages to get. all the pages, or however many you asked for. 📚
  • -v, --verbose[=false] — verbose logging. say more, say everything. 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable using --view off. views = the pretty presentation layer. 🌈
  • --withError[=false] — errors will be printed on stdout instead of stderr. not the usual, but sometimes you need it. 🔀
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). count the elements, king. 🧮
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. page count, included. 📄
  • --workers=1 — number of workers. more workers = more parallel energy, but 1 is the default if you like it calm. 👯‍♀️

✨ SEE ALSO ✨

these are the sibling commands, the rest of the family, the group chat members. go check them out when you're done here:

okay that's the whole page, every flag, every default, every warning, every SEE ALSO. you're officially smarter than 90% of people who just run the command and pray. no cap. 💖✨

and yes, this page is dated Jan 1980 and lives under c8y(1) — yes it's old, yes it's still iconic, yes it ate. now go configure your tenant options, bestie. 🎀🦋💅

📦 where this page comes from