c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y-tenants — Cumulocity tenant 🦋

okay so real quick before we dive in: this is a page from the c8y manual (that's the c8y(1) one), and it's all about the c8y-tenants command. Bestie, let's get into it ✨

🌸 SYNOPSIS 🌸

c8y tenants [flags]

that's it. that's the whole invocation. short and iconic fr fr 💅

🎀 DESCRIPTION 🎀

it's a REST endpoint to interact with Cumulocity tenants. that's the vibe — you're talking to the tenants endpoint, that's what this does 🫶

⭐ OPTIONS ⭐

  • -h, --help[=false] — shows help for tenants. the classic. the goat. use it when you're lost 💖

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

so these aren't this command's own flags — they're handed down from the parent command, and they work here too. there's a lot of them, so buckle up bestie 👑

  • --abortOnErrors=10 — aborts the batch once you hit the specified number of errors
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty 🙈
  • --cache[=false] — turns on cached responses
  • --cacheBodyPaths=[] — tells the cache to only hash the selected paths inside the json body; empty means all values get hashed
  • --cacheTTL="60s" — cache time-to-live (TTL) written 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 the output is the terminal ✨
  • --confirm[=false] — prompts you for confirmation
  • --confirmText="" — custom confirmation text
  • --currentPage=0 — the current page that should be returned
  • --customQueryParam=[] — adds custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — sets 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. sends absolutely nothing to the server 💀
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl
  • --examples[=false] — shows examples for the current command
  • --filter=[] — applies a client side filter to the response before it goes back to you
  • --flatten[=false] — flattens json output by replacing nested json properties with properties whose names are written in dot notation
  • -f, --force[=false] — don't prompt for confirmation. this one gets ignored when you're using --confirm
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — includes all results by iterating through each page 🦋
  • -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! ⚠️ like genuinely, caution)
  • --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] — force-disables cached responses (overwrites the 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] — disables progress bars
  • --noProxy[=false] — ignores the proxy settings
  • -n, --nullInput[=false] — don't read the input (stdin). useful if you're using it in shell for/while loops 🧚
  • -o, --output="table" — output format, i.e. 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="" — jsonnet template to apply to the output
  • -p, --pageSize=5 — maximum results per page
  • --progress[=false] — show a progress bar. this also disables any other verbose output
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080
  • -r, --raw[=false] — show the raw response. this mode forces 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="" — overrides the 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 don't affect the exit code
  • --silentStatusCodes="" — status codes that won't 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 with --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

👑 SEE ALSO 👑

go read these too, they're all part of the family 🫶

okay that's the whole page, no notes 💖 oh and for the record — this one's dated Jan 1980 and it belongs to the c8y(1) manual. yes, 1980. we don't ask questions, we just slay 🎀✨

go touch some grass and then come back and read your --help output, i believe in you 🍓
📦 where this page comes from