c8y(1)

okay so bestie, welcome to the c8y manual — this one is all about c8y-systemoptions-list, aka the c8y systemoptions list command — and it's literally here to get the system option collection. no cap, it's giving read-only platform config realness. ✨💅

🌸 NAME 🌸

c8y-systemoptions-list — Get system option collection

🦋 SYNOPSIS 🦋

c8y systemoptions list [flags]

✨ DESCRIPTION ✨

You're getting a collection of system options, bestie. This endpoint provides a set of read-only properties pre-defined in platform configuration — so yes, it's literally read-only, no cap. The response format is exactly the same as for OptionCollection. 🫶

💅 OPTIONS 💅

• -h, --help[=false] — help for list

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

• --abortOnErrors=10 — abort the batch when reaching the specified number of errors. The number here is 10. 🛑
• --allowEmptyPipe[=false] — don't fail when piped input (stdin) is empty. 💧
• --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!). ⚠️
• --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 🍓

this is the whole example, bestie — it gets a list of system options:

$ c8y systemoptions list
Get a list of system options

🌈 SEE ALSO 🌈

• c8y-systemoptions(1)

xoxo, bestie — source/version: c8y(1), date: Jan 1980. go get those system options. 💖🎀✨