c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸ’– c8y(1) β€” tenantoptions create, bestie edition πŸ’–

Hey bestie! This is the c8y(1) page for c8y tenantoptions create, and yes, we're making tenant options cute today. ✨

🌸 NAME 🌸

c8y-tenantoptions-create β€” create tenant option. That's the name, that's the job. Periodt. πŸ’…

πŸ¦‹ SYNOPSIS πŸ¦‹

c8y tenantoptions create [flags]

πŸŽ€ DESCRIPTION πŸŽ€

Create tenant option. Literally just create the tenant option, bestie. πŸ‘‘

πŸ”₯ OPTIONS πŸ”₯

  • --category="" β€” Category of option. Tell it which category this option belongs to. πŸ’–
  • -d, --data=[] β€” static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'. ✨
  • -h, --help[=false] β€” help for create. 🫢
  • --key="" β€” Key of option (accepts pipeline). πŸ”‘
  • --processingMode="" β€” Cumulocity processing mode. 🌈
  • --template="" β€” Body template. πŸŽ€
  • --templateVars=[] β€” Body template variables. πŸ¦‹
  • --value="" β€” Value of option. πŸ’…

🌈 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, 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 πŸ“

Here's the little example, bestie β€” copy it exactly:

$ c8y tenantoptions create --category "c8y_cli_tests" --key "option1" --value "1"
Create a tenant option

🫢 SEE ALSO 🫢

c8y-tenantoptions(1) β€” go peek at the parent command, iykyk. πŸ’œ


That's the whole page, bestie πŸ’– source/version: c8y(1), date: Jan 1980. Slay and stay hydrated! πŸŽ€

πŸ“¦ where this page comes from