c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the retention-rules-create glow-up ✨

okay bestie, listen. this is the c8y manual page, and honestly? it's giving "powerful CLI that deserves a proper hype moment." we're specifically looking at c8y-retentionrules-create, aka the little command that decides when your data gets yeeted from the tenant 🗑️✨ no cap, it's kind of a big deal.

✨ NAME ✨

c8y-retentionrules-create — Create retention rule 🎀

🌸 SYNOPSIS 🌸

c8y retentionrules create [flags]

🦋 DESCRIPTION 🦋

okay so picture this: you want a brand-new retention rule that manages when data gets deleted in the tenant. that's literally the whole job. create it, and the tenant knows what's up. main character energy for your data lifecycle 💅

👑 OPTIONS 👑

  • -d, --data=[] — static data to be applied to body. it accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' — yes bestie, nested values are slaying 🫶
  • --dataType="" — the RetentionRule gets applied to this type of documents. possible values are [ALARM, AUDIT, EVENT, MEASUREMENT, OPERATION, *]. (accepts pipeline) — the * is the "everything" icon, use responsibly 😌
  • --editable[=false] — whether the rule is editable. it can be updated only by management tenant. lowkey exclusive 💀
  • --fragmentType="" — the RetentionRule gets applied to documents with fragmentType.
  • -h, --help[=false] — help for create. the classic 🎀
  • --maximumAge=0 — maximum age of document in days. that's the number that decides when stuff dips ✌️
  • --processingMode="" — Cumulocity processing mode.
  • --source="" — the RetentionRule gets applied to documents with source.
  • --template="" — body template.
  • --templateVars=[] — body template variables.
  • --type="" — the RetentionRule gets applied to documents with type.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the vibes you inherit from the parent, and there are so many, but we're listing every single one because we don't skip ✨

  • --abortOnErrors=10 — abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe? not a crisis 💅
  • --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. it's giving "i need to see everything" 🔍
  • --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. pretend mode, no consequences 🧚
  • --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. ⚠️ questionable choices, but okay.
  • -l, --logMessage="" — add custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) — the exclamation mark is doing heavy lifting fr 😭
  • --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 🍓

$ c8y retentionrules create --dataType ALARM --maximumAge 180
Create a retention rule

look at her go 💖 alarms, 180 days, rule created. iconic.

💜 SEE ALSO 💜

and that's the page bestie!! ✨ no cap, you're now fully briefed on c8y. this lovely piece of documentation is dated Jan 1980, which is genuinely so vintage of it 💀 — go forth and create those retention rules, queen 👑💅🌈

📦 where this page comes from