c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌸 c8y(1) 🌸

okay bestie, welcome to the c8y(1) manual page — manual name folded in right here at the top, no boring header line, we move. This corner of the group chat is all about c8y-tenants-get, and it's lowkey iconic. 💅

✨ NAME ✨

c8y-tenants-get — get tenant. Just one tenant. Main character energy, honestly. 🫶

🦋 SYNOPSIS 🦋

c8y tenants get [flags]

💖 DESCRIPTION 💖

Get an existing tenant. That's the vibe. No cap. 🎀

👑 OPTIONS 👑

  • -h, --help[=false] — help for get. Defaults to false; you gotta ask for it. 💅
  • --id="" — the tenant id. It accepts pipeline input, so yes, pipe it in like the icon you are. 🫶

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

These are the parent-command options that come along for the ride, bestie. 👑

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors. Default is 10, so it's got a limit. 🛑
  • --allowEmptyPipe[=false] — don't fail when piped input on stdin is empty. Default false. 🫶
  • --cache[=false] — enable cached responses. Cute. Default false. 🎀
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body; empty indicates all values. Default []. 🦋
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, like 60s or 2m. Default "60s". ⏳
  • -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. Default false. 🙈
  • --confirmText="" — custom confirmation text. Default "". 📝
  • --currentPage=0 — current page which should be returned. Default 0. 📄
  • --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Default []. 🔗
  • --debug[=false] — set very verbose log messages. Default false. 🐛
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. Default "0ms". ⏱️
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Default "0ms". ⏱️
  • --dry[=false] — dry run. Don't send any data to the server. Default false. 🧪
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl. Default "markdown". 📦
  • --examples[=false] — show examples for the current command. Default false. ✨
  • --filter=[] — apply a client side filter to the response before returning it to the user. Default []. 🧚
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. Default false. 🪄
  • -f, --force[=false] — do not prompt for confirmation. Ignored when using --confirm. Default false. 💥
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue". Default []. 📨
  • --includeAll[=false] — include all results by iterating through each page. Default false. 🔁
  • -k, --insecure[=false] — allow insecure server connections when using SSL. Default false. 😬
  • -l, --logMessage="" — add custom message to the activity log. Default "". 📝
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). Default 0. ⚠️
  • --noAccept[=false] — ignore Accept header; this will remove the Accept header from requests, however PUT and POST requests will only see the effect. Default false. 🚫
  • --noCache[=false] — force disabling of cached responses, overwriting the cache setting. Default false. 🧊
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. Default false. 🎨
  • --noLog[=false] — disables the activity log for the current command. Default false. 🔇
  • --noProgress[=false] — disable progress bars. Default false. 🚫
  • --noProxy[=false] — ignore the proxy settings. Default false. 🕳️
  • -n, --nullInput[=false] — don't read the input (stdin). Useful if using in shell for/while loops. Default false. 🌀
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader. Default "table". 📊
  • --outputFile="" — save JSON output to file (after select/view). Default "". 💾
  • --outputFileRaw="" — save raw response to file (before select/view). Default "". 🗃️
  • --outputTemplate="" — jsonnet template to apply to the output. Default "". 🧩
  • -p, --pageSize=5 — maximum results per page. Default 5. 📚
  • --progress[=false] — show progress bar. This will also disable any other verbose output. Default false. 📈
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. Default "". 🌐
  • -r, --raw[=false] — show raw response. This mode will force output=json and view=off. Default false. 🥩
  • --retries=3 — max number of attempts when a failed http call is encountered. Default 3. 🔄
  • --select=[] — comma separated list of properties to return. Wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Default []. 🎯
  • --session="" — session configuration. Default "". 🔐
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. Default "". 🎛️
  • -P, --sessionPassword="" — override session password. Default "". 🤫
  • -U, --sessionUsername="" — override session username, i.e. peter or t1234/peter (with tenant). Default "". 👤
  • --silentExit[=false] — silent status codes do not affect the exit code. Default false. 🤐
  • --silentStatusCodes="" — status codes which will not print out an error message. Default "". 🔕
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. Default "600s". ⏳
  • --totalPages=0 — total number of pages to get. Default 0. 📖
  • -v, --verbose[=false] — verbose logging. Default false. 🗣️
  • --view="auto" — use views when displaying data on the terminal. Disable using --view off. Default "auto". 👀
  • --withError[=false] — errors will be printed on stdout instead of stderr. Default false. 📤
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Default false. 🔢
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Default false. 📑
  • --workers=1 — number of workers. Default 1. 👯

🎀 EXAMPLE 🎀

$ c8y tenants get --id "mycompany"

Get a tenant by name — from the management tenant, bestie. 🫶

🌟 SEE ALSO 🌟

  • c8y-tenants(1) — the tenant command family; go snoop there too. 🧚

okay bestie, that's the whole page. tiny footer sign-off time: source/version + date — c8y(1), Jan 1980. mwah 💖✨

📦 where this page comes from