c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y — the group chat for your Cumulocity CLI era 💖

okay so bestie, welcome to c8y(1) — that's the manual name btw, we're hanging out in section 1 of the Unix manual pages and honestly? iconic. pull up a chair, grab a boba, and let's get into it ✨

✨ NAME ✨

c8y-tenants-update — Update tenant. that's it, that's the whole vibe. we're updating a tenant and we're gonna slay doing it 💅

🦋 SYNOPSIS 🦋

c8y tenants update [flags]

🌸 DESCRIPTION 🌸

Update an existing tenant. lowkey simple, highkey powerful — you point it at a tenant that already exists and you change stuff about it. no cap, that's the whole job 🫶

🎀 OPTIONS 🎀

okay bestie here's the full roster, no skips, no cuts, every single one:

  • --adminEmail="" — the email address of the tenant's administrator 📧
  • --adminName="" — the username of the tenant administrator
  • --adminPass="" — the password of the tenant administrator (yes, a password. be normal about it 🙈)
  • --allowCreateTenants[=false] — lets the tenant create sub-tenants, like a tenant having its own little tenants, it's giving nepo baby but make it infrastructure 👑
  • --contactName="" — a contact name for the tenant, for example an administrator
  • --contactPhone="" — an international contact phone number ☎️
  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' — the shorthand is so cute fr
  • --domain="" — domain name to be used for the tenant. Maximum 256 characters ⭐
  • -h, --help[=false] — help for update. classic
  • --id="" — Tenant id (accepts pipeline). yes bestie, you can pipe it in 🔥
  • --name="" — Company name. Maximum 256 characters
  • --processingMode="" — Cumulocity processing mode
  • --template="" — Body template
  • --templateVars=[] — Body template variables

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these bad boys come from the parent command, so they work here too. love that for us:

  • --abortOnErrors=10 — abort batch when reaching specified number of errors. like, we tried, we failed, we're out 💀
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). she's forgiving
  • --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, 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
  • --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. she's loud and we love her 📢
  • --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. scrunch it flat 🫶
  • -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. bestie. be careful. that's the warning, that's the whole warning ⚠️
  • -l, --logMessage="" — Add custom message to the activity log
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!) — literally the manpage itself is yelling caution, listen to it 😭
  • --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. sad beige terminal 🌈
  • --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 🔥

okay so this is the moment, the demo, the main character scene:

$ c8y tenants update --id "mycompany" --contactName "John Smith"

Update a tenant by name (from the management tenant). ate and left no crumbs 💅

⭐ SEE ALSO ⭐

  • c8y-tenants(1) — go read the parent, she's the whole family tree 🌳

and that's the page bestie 🎀 ngl you understood all of it, i'm obsessed. this one's dated Jan 1980 and it lives under the manual name c8y(1) — yes the same c8y we've been shouting about this whole time. mwah, go update a tenant 💜✨

📦 where this page comes from