c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 NAME 💖

c8y-tenants-disable — okay so this is literally the command that disables or suspends a tenant. Bestie, it's giving "pause button for a whole company" energy. 🎀

🎀 SYNOPSIS 🎀

c8y tenants disable [flags]

✨ DESCRIPTION ✨

So you've got an existing tenant and you need to disable or suspend it? This is the slay command for that. It's the off switch, the "you're on timeout" button, the—okay you get it. 💅

🌸 OPTIONS 🌸

  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, like --data 'value1=1,my.nested.value=100' — yes, that shorthand is iconic
  • -h, --help[=false] — help for disable (shows you the tea)
  • --id="" — Tenant id (accepts pipeline, so you can pipe it in fr fr)
  • --processingMode="" — Cumulocity processing mode
  • --template="" — Body template
  • --templateVars=[] — Body template variables

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

These are the hand-me-downs from c8y-tenants and they are lowkey doing the most. Every single one is here, bestie, no cap:

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors — default is 10
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin) — default is false
  • --cache[=false] — Enable cached responses — default is false
  • --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, i.e. 60s, 2m — default is "60s"
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal — default is false
  • --confirm[=false] — Prompt for confirmation — default is false
  • --confirmText="" — Custom confirmation text
  • --currentPage=0 — Current page which should be returned — default is 0
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — Set very verbose log messages — default is false
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s — default is "0ms"
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s — default is "0ms"
  • --dry[=false] — Dry run. Don't send any data to the server — default is false
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl — default is "markdown"
  • --examples[=false] — Show examples for the current command — default is false
  • --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 — default is false
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm — default is false
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — Include all results by iterating through each page — default is false
  • -k, --insecure[=false] — Allow insecure server connections when using SSL — default is false
  • -l, --logMessage="" — Add custom message to the activity log
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!) — default is 0
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect — default is false
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting) — default is false
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console — default is false
  • --noLog[=false] — Disables the activity log for the current command — default is false
  • --noProgress[=false] — Disable progress bars — default is false
  • --noProxy[=false] — Ignore the proxy settings — default is false
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops — default is false
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader — default is "table"
  • --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 — default is 5
  • --progress[=false] — Show progress bar. This will also disable any other verbose output — default is false
  • --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 — default is false
  • --retries=3 — Max number of attempts when a failed http call is encountered — default is 3
  • --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 — default is false
  • --silentStatusCodes="" — Status codes which will not print out an error message
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m — default is "600s"
  • --totalPages=0 — Total number of pages to get — default is 0
  • -v, --verbose[=false] — Verbose logging — default is false
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off — default is "auto"
  • --withError[=false] — Errors will be printed on stdout instead of stderr — default is false
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13) — default is false
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages — default is false
  • --workers=1 — Number of workers — default is 1

🔥 EXAMPLE 🔥

$ c8y tenants disable --id "mycompany"
Disable a tenant (from the management tenant)

Okay so literally you just pass the tenant id and it does the thing. The example shows disabling "mycompany" from the management tenant. Iconic. 🙈

🫶 SEE ALSO 🫶

c8y-tenants(1) — go check out the parent command for the full tenant tea 💜

✨ that's the whole vibe ✨ — this page is from the c8y manual, dated Jan 1980 (yes, the vibe is vintage but the command is timeless, bestie). Stay slaying those tenants. 💅🎀

📦 where this page comes from