c8y(1)

📦 version 2.56.1, in nixpkgs unstable

c8y 🎀 — the c8y-tenants-create manual, bestie edition

okay so you opened c8y(1) and landed on the c8y tenants create page, and honestly? iconic choice. this is the whole thing, same facts, way better vibes 💅

✨ NAME ✨

c8y-tenants-create — Create tenant

🌸 SYNOPSIS 🌸

c8y tenants create [flags]

🦋 DESCRIPTION 🦋

Create a new tenant. that's it, that's the whole vibe. you're birthing a whole new tenant into existence, main character energy ✨

💖 OPTIONS 💖

  • --adminEmail="" — the email address of the tenant's administrator 📧
  • --adminName="" — the username of the tenant administrator
  • --adminPass="" — the password of the tenant administrator (keep it secret, keep it safe 🔐)
  • --allowCreateTenants[=false] — let this tenant create sub-tenants. yes, tenants making tenants, it's giving recursion 🌀
  • --contactName="" — a contact name for the tenant, like an administrator
  • --contactPhone="" — an international contact phone number ☎️
  • -d, --data=[] — static data to be applied to the body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
  • --domain="" — domain name to be used for the tenant. maximum 256 characters (accepts pipeline)
  • -h, --help[=false] — help for create. always here for you 🫶
  • --name="" — company name. maximum 256 characters
  • --processingMode="" — Cumulocity processing mode
  • --sendPasswordResetEmail[=false] — send a password reset email to the user instead of setting a password
  • --template="" — body template
  • --templateVars=[] — body template variables
  • --tenantId="" — the tenant ID. this should be left bank unless you know what you are doing. will be auto-generated if not present.
ngl bestie, that --tenantId one is a "hands off unless you're a wizard" situation. let it auto-generate, live your life 💀

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the little hand-me-downs from the parent command, and there are so many, but we do not skip. we list all of them. periodt 👑

  • --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, 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
  • --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 ⭐

the receipts, bestie, here's exactly how you do it:

$ c8y tenants create --name "mycompany" --domain "mycompany" --adminEmail "admin@example.com" --adminName "admin" --adminPass "mys3curep9d8"
Create a new tenant (from the management tenant)
$ c8y tenants create --name "mycompany" --domain "mycompany" --adminEmail "admin@example.com" --adminName "admin" --sendPasswordResetEmail
Create a new tenant and send a password reset email (from the management tenant)

see how the second one swaps the password for --sendPasswordResetEmail? slay. let them set their own password 💅

🧚 SEE ALSO 🧚

c8y-tenants(1) — go read the parent page too, it's giving lore 🌸

and that's the whole page, no cap. every flag, every default, every example — all accounted for 🫶

this page is from Jan 1980, and it's part of the c8y(1) manual — yes the date is literally Jan 1980, we don't question the timeline, we just vibe with it 💜🎀

📦 where this page comes from