c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸ’– c8y(1) β€” c8y-currenttenant-get πŸ’–

okay so this is the c8y(1) manual page for c8y-currenttenant-get, and it’s literally about getting your current tenant. bestie, it’s giving β€œwho am I in this session rn?” energy. ✨

🌸 NAME 🌸

c8y-currenttenant-get β€” Get current tenant. and yes, the manual name is c8y(1), iykyk πŸ’…

πŸ¦‹ SYNOPSIS πŸ¦‹

c8y currenttenant get [flags]

✨ DESCRIPTION ✨

Get the current tenant associated with the current session. that’s the whole plot: this command asks for the current tenant tied to your current session. no cap. πŸŽ€

πŸ’… OPTIONS πŸ’…

  • -h, --help[=false] β€” shows help for get, bestie. 🫢
  • --withParent[=false] β€” when set to true, the returned result will contain the parent of the current tenant. iconic. πŸ‘‘

πŸ‘‘ OPTIONS INHERITED FROM PARENT COMMANDS πŸ‘‘

these are inherited from the parent commands, so they come through with the group-chat energy too:

  • --abortOnErrors=10 β€” abort the batch when it reaches the specified number of errors. default is 10, so yeah. πŸ’€
  • --allowEmptyPipe[=false] β€” don’t fail when the piped input (stdin) is empty. no drama. πŸŽ€
  • --cache[=false] β€” enable cached responses. caching slay. ✨
  • --cacheBodyPaths=[] β€” make cache limit hashing to selected paths in the json body. empty means 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. say it with your chest. πŸŽ€
  • --currentPage=0 β€” the 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 😭

fr fr, here’s how it looks:

$ c8y currenttenant get
Get the current tenant (based on your current credentials)

$ c8y currenttenant get --withParent
Get the current tenant including the parent tenant (based on your current credentials)

🌈 SEE ALSO 🌈


okay that’s the page, bestie 🫢 β€” manual/source: c8y(1), date: Jan 1980. slay and bye. πŸ’–

πŸ“¦ where this page comes from