c8y(1)

📦 version 2.56.1, in nixpkgs unstable

✨ NAME ✨

c8y-tenants-assert-exists — Assert existence of a tenant 💖 (yep bestie, you're in the c8y(1) manual)

🌸 SYNOPSIS 🌸

c8y tenants assert exists [flags]

🦋 DESCRIPTION 🦋

okay so this command asserts that a tenant exists or not, and then passes the input through untouched.

If the assertion is true, then the input value (stdin or an explicit argument value) will be passed untouched to stdout. This is useful if you want to filter a list of tenants by whether they exist or not in the platform, and use the results in some downstream command (in the pipeline). it's giving filter-and-forward realness ✨

By default, a failed assertion will not set the exit code to a non-zero value. If you want a non-zero exit code in that case, then use the --strict option. periodt 💅

💅 OPTIONS 💅

  • --attempts=-1 — number of attempts before giving up per id (-1 = unlimited)
  • --duration="30s" — timeout duration, like 30s or 1m (1 minute)
  • -h, --help[=false] — help for exists
  • --interval="5s" — interval to check on the status, like 10s or 1min
  • --not[=false] — negate the match
  • --strict[=false] — strict mode, fail if no match is found
  • --tenant=[] — tenant id (accepts pipeline)

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

  • --abortOnErrors=10 — abort batch when reaching specified number of errors
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin)
  • --cache[=false] — enable cached responses
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body; empty indicates all values
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, like 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
  • --currentPage=0 — current page which should be returned
  • --customQueryParam=[] — add custom URL query parameters, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — set very verbose log messages
  • --delay="0ms" — delay after each request, like 5ms, 1.2s
  • --delayBefore="0ms" — delay before each request, like 5ms, 1.2s
  • --dry[=false] — dry run; don't send any data to the server
  • --dryFormat="markdown" — dry run output format, like 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, like --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; removes 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, like 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, like 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, like --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, like 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, like 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 🔥

$ c8y tenants assert exists --tenant t12345
# => t12345 (if the tenant exists)
# => <no response> (if the tenant does not exist)
# Assert the tenant exists

$ echo "t12345" | c8y tenants assert exists
# Pass the piped input only on if the tenant exists

$ echo -e "t11111\nt22222" | c8y tenants assert exists --not
# Only select the tenant ids which do not exist

$ echo t12345 | c8y tenants assert exists --strict
# Return non-zero exit code if tenant t12345 does not exist

🌈 SEE ALSO 🌈

c8y-tenants-assert(1)

xoxo bestie 💖 that's the c8y(1) manual, Jan 1980 edition, signing off 💅✨🫶

📦 where this page comes from