c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y manual, bestie edition 🎀

okay so real talk — this is c8y(1), like the actual c8y command manual page, and we're specifically deep-diving c8y-systemoptions-get. yes that's a long name. yes it's iconic. stay with me 🫶

✨ NAME ✨

c8y-systemoptions-get — Get system option 🌸

like. it gets a system option. that's the whole vibe check. 💅

🌈 SYNOPSIS 🌈

c8y systemoptions get [flags]

that's it. that's the incantation. flags are where the fun lives, keep scrolling 👑

🦋 DESCRIPTION 🦋

Get a system option by category and key.

fr fr, that's the entire description — category plus key, and the option is yours. no cap, it's giving minimalism. ✨

💖 OPTIONS 💖

these are the options that belong to this command specifically. look at them. love them. 🍓

  • --category="" — the System Option category. required, bestie, you literally cannot skip it 🙈
  • -h, --help[=false] — help for get. the classic "what does this even do" button 🫶
  • --key="" — the System Option key. required too! and plot twist: it accepts pipeline, so you can pipe stuff in. iykyk 💜

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

okay these are the ones you didn't ask for but got anyway, because the parent command said "here, take my whole wardrobe" 💀 literally the entire collection. there are so many. i counted. we're doing all of them. periodt.

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors. ten strikes and it's out ✨
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. very forgiving. very demure 🎀
  • --cache[=false] — enable cached responses. speed. ⚡
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty indicates all values. so like, empty = everything, no thoughts head empty 🧚
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. it expires. everything expires eventually 💀
  • -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 automatically serving looks ✨
  • --confirm[=false] — prompt for confirmation. it asks first, consent is key 🫶
  • --confirmText="" — custom confirmation text. make it say whatever you want 💖
  • --currentPage=0 — current page which should be returned. page zero. the origin story 📖
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. build your own little query, main character energy 👑
  • --debug[=false] — set very verbose log messages. it will NOT stop talking and honestly? relatable 😭
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. a little pause. self care 🌸
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. a little pause, but earlier ✨
  • --dry[=false] — dry run. don't send any data to the server. it's a rehearsal, not the actual performance 🎭
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl. pick your aesthetic 💅
  • --examples[=false] — show examples for the current command. yes bestie, show me the receipts 🧾
  • --filter=[] — apply a client side filter to response before returning it to the user. filtering locally, we love a shortcut 🌈
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested? not anymore. we flattened it. 🦋
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. bold of you. iconic of you. 👑
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". accessorize your request 🎀
  • --includeAll[=false] — include all results by iterating through each page. all of them. every single one. we don't leave anyone behind 🫶
  • -k, --insecure[=false] — allow insecure server connections when using SSL. it's literally called insecure, be careful bestie 😭
  • -l, --logMessage="" — add custom message to the activity log. leave a little note for future you ✨
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). use with caution!! they said it, not me 💀
  • --noAccept[=false] — ignore Accept header, will remove the Accept header from requests, however PUT and POST requests will only see the effect. sneaky, but only partly 🕵️
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). cache said no? cache said NO. 💅
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome moment. sad but valid 🖤
  • --noLog[=false] — disables the activity log for the current command. what happens in the command stays in the command 🙈
  • --noProgress[=false] — disable progress bars. no little loading guys. they're gone 🫥
  • --noProxy[=false] — ignore the proxy settings. straight to the source, no middleman 🧚
  • -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. very handy, very specific 🔥
  • -o, --output="table" — output format i.e. table, json, csv, csvheader. default is table because tables ate 🍽️
  • --outputFile="" — save JSON output to file (after select/view). it's the after picture 📸
  • --outputFileRaw="" — save raw response to file (before select/view). the before picture, unfiltered 🎞️
  • --outputTemplate="" — jsonnet template to apply to the output. customize the fit 💖
  • -p, --pageSize=5 — maximum results per page. five. that's the number. ⭐
  • --progress[=false] — show progress bar. this will also disable any other verbose output. it's a trade-off, bestie ⚖️
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. route it through the middleman 🌉
  • -r, --raw[=false] — show raw response. this mode will force output=json and view=off. no filter, no edits, raw footage 🎬
  • --retries=3 — max number of attempts when a failed http call is encountered. three tries. it's trying its best 😭
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. cherry-pick your faves 🍒
  • --session="" — session configuration. your whole session situation 🪪
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. special occasion, special mode ✨
  • -P, --sessionPassword="" — override session password. shhh 🤫
  • -U, --sessionUsername="" — override session username. i.e. peter or t1234/peter (with tenant). hi peter 👋
  • --silentExit[=false] — silent status codes do not affect the exit code. quiet quitting, exit-code edition 💅
  • --silentStatusCodes="" — status codes which will not print out an error message. some errors just don't get to speak 🙊
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. ten minutes of patience, then we're done waiting ⏰
  • --totalPages=0 — total number of pages to get. how many pages? yes. 📚
  • -v, --verbose[=false] — verbose logging. it says everything. everything. 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable using --view off. auto is the default, so it just vibes ✨
  • --withError[=false] — errors will be printed on stdout instead of stderr. moving the drama to a different stream 🎭
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). note the version, it matters 🗓️
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. pages, but with receipts 🧾
  • --workers=1 — number of workers. one worker. they're doing their best 🫡

🌟 EXAMPLE 🌟

here's the moment you've all been waiting for:

$ c8y systemoptions get --category "system" --key "version"
Get a list of system options

look at that. category system, key version, and the output says "Get a list of system options". slay. ate. no crumbs. 🔥

🎀 SEE ALSO 🎀

and that's the page, bestie 💜 it's from Jan 1980 (yes, literally, that's the date at the bottom, vintage behavior) and it's filed under the source/version line c8y(1). go forth and get those system options 🦋✨💅

📦 where this page comes from