c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 NAME 💖

okay so welcome to the c8y(1) manual page bestie!! this one's all about c8y-databroker-list — the lil command that gets you a data broker collection. yep. that's the whole vibe. ✨

🦋 SYNOPSIS 🦋

that's it. that's the whole thing. flags are optional but honestly kind of the main character here 👑

🌸 DESCRIPTION 🌸

it gets you a collection of existing data broker connectors. like, all of them. the whole squad. no cap 💅

✨ OPTIONS ✨

  • -h, --help[=false] — shows you the help for list. the "wait what does this do again" button 🫶

🎀 OPTIONS INHERITED FROM PARENT COMMANDS 🎀

these ones are literally handed down from the parent command like a family heirloom. there are a LOT of them. buckle up bestie 😭

  • --abortOnErrors=10 — bails on the whole batch once you hit the specified number of errors
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. very forgiving of you 💜
  • --cache[=false] — turns on cached responses
  • --cacheBodyPaths=[] — the cache should limit hashing to the selected paths in the json body. empty means all values get hashed
  • --cacheTTL="60s" — cache time-to-live (TTL) written as a duration, like 60s or 2m
  • -c, --compact[=false] — compact output instead of pretty-printed when you're using json output. pretty print is the default when output is the terminal
  • --confirm[=false] — prompts you for confirmation
  • --confirmText="" — your own custom confirmation text. make it cute 🎀
  • --currentPage=0 — the current page that should be returned
  • --customQueryParam=[] — adds custom URL query parameters, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — sets very verbose log messages. the "tell me EVERYTHING" setting 🗣️
  • --delay="0ms" — delay after each request, like 5ms or 1.2s
  • --delayBefore="0ms" — delay before each request, like 5ms or 1.2s
  • --dry[=false] — dry run. doesn't send any data to the server. fake it till you make it energy 🙈
  • --dryFormat="markdown" — the dry run output format, like json, dump, markdown or curl
  • --examples[=false] — shows examples for the current command
  • --filter=[] — applies a client side filter to the response before it gets returned to you
  • --flatten[=false] — flattens json output by swapping nested json properties for properties whose names are written in dot notation
  • -f, --force[=false] — do not prompt for confirmation. ignored when you're using --confirm (they do NOT play nice together, pick a lane 💀)
  • -H, --header=[] — custom headers, like --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — includes all results by iterating through each page. all of them. every single one 🌀
  • -k, --insecure[=false] — allows insecure server connections when using SSL
  • -l, --logMessage="" — adds a custom message to the activity log
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution! fr fr, be careful with this one ⚠️)
  • --noAccept[=false] — ignores the Accept header, which removes the Accept header from requests — however PUT and POST requests will only see the effect
  • --noCache[=false] — forces cached responses off (overwrites the cache setting)
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome moment 🖤
  • --noLog[=false] — disables the activity log for the current command
  • --noProgress[=false] — disables progress bars
  • --noProxy[=false] — ignores the proxy settings
  • -n, --nullInput[=false] — don't read the input (stdin). super useful if you're using it in a shell for/while loop
  • -o, --output="table" — output format, like table, json, csv, csvheader
  • --outputFile="" — saves JSON output to a file (after select/view)
  • --outputFileRaw="" — saves the raw response to a file (before select/view)
  • --outputTemplate="" — a jsonnet template to apply to the output
  • -p, --pageSize=5 — maximum results per page
  • --progress[=false] — shows the progress bar. this also disables any other verbose output (sorry, can't have both 😔)
  • --proxy="" — proxy setting, like http://10.0.0.1:8080
  • -r, --raw[=false] — shows the raw response. this mode forces output=json and view=off
  • --retries=3 — max number of attempts when a failed http call is encountered. we try again, and again, and again 🫡
  • --select=[] — comma separated list of properties to return. wildcards and globstar are accepted, like --select 'id,name,type,**.serialNumber'
  • --session="" — session configuration
  • --sessionMode="" — overrides the default session mode for a single command, which would normally be disabled
  • -P, --sessionPassword="" — overrides the session password
  • -U, --sessionUsername="" — overrides the session username, like peter or t1234/peter (with tenant)
  • --silentExit[=false] — silent status codes do not affect the exit code
  • --silentStatusCodes="" — status codes that will not print out an error message. shhh 🤫
  • --timeout="600s" — request timeout duration, like 60s or 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 it using --view off
  • --withError[=false] — errors get printed on stdout instead of stderr
  • --withTotalElements[=false] — asks Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13)
  • -t, --withTotalPages[=false] — asks Cumulocity to include the total pages in the response statistics under .statistics.totalPages
  • --workers=1 — number of workers

🔥 EXAMPLE 🔥

$ c8y databroker list
Get a list of data broker connectors

look at her go. iconic behavior honestly 🌈

🌟 SEE ALSO 🌟

and that's the whole page bestie!! this little beauty is dated Jan 1980 and lives under c8y(1) — vintage but still slaying, periodt 💅✨🎀

📦 where this page comes from