c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 NAME 💅

okay so this is the c8y(1) manual page for c8y-tenants-assert — Cumulocity tenant assertions. periodt. 💖

✨ SYNOPSIS ✨

c8y tenants assert [flags]

🎀 DESCRIPTION 🎀

Assertions for Cumulocity tenants. literally that. it's giving tenant-assertion main character energy. 💅

🌸 OPTIONS 🌸

  • -h, --help[=false] — shows help for assert. bestie, when in doubt, ask for help. 🫶

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

these are inherited from the parent commands, no cap:

  • --abortOnErrors=10 — abort the batch when you reach the specified number of errors. bail once it hits 10, iykyk.
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. empty pipe? not a crisis. 🌸
  • --cache[=false] — enable cached responses. cozy cached vibes. ✨
  • --cacheBodyPaths=[] — cache should limit hashing of 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. yes bestie, it wants a vibe check first. 🙈
  • --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. it's giving detective mode. 🔥
  • --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. manifesting without sending, iconic. 💅
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl.
  • --examples[=false] — show examples for the current command. tutorial era. 🎀
  • --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. no asking, just doing.
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — include all results by iterating through each page. all of it, bestie. 🌈
  • -k, --insecure[=false] — allow insecure server connections when using SSL. dangerous-ish behavior, so be mindful bestie. 💀
  • -l, --logMessage="" — add custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). caution is literally in the name, bestie. 🔥
  • --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. monochrome moment. 🖤
  • --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. no stdin, no problem. 🦋
  • -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. five at a time, cute. 🍓
  • --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. three strikes energy. 😭
  • --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. spill the tea, logs. 🫖
  • --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. one worker, unless you decide otherwise. 💜

🌈 SEE ALSO 🌈

xoxo, your c8y(1) bestie 💖 — Jan 1980 edition, periodt. 🎀

📦 where this page comes from