c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

🌸 NAME 🌸

c8y-retentionrules-delete β€” Delete retention rule β€” and yes bestie, you're in the c8y(1) manual, we're doing this πŸ’–

πŸ¦‹ SYNOPSIS πŸ¦‹

c8y retentionrules delete [flags]

✨ DESCRIPTION ✨

Delete an existing retention rule β€” that's literally the whole assignment, no cap πŸ’…

πŸŽ€ OPTIONS πŸŽ€

  • -h, --help[=false] β€” help for delete β€” the classic "pls explain" button πŸ™ˆ
  • --id=[] β€” Retention rule id (required) (accepts pipeline) β€” required, bestie, don't skip it 🫢
  • --processingMode="" β€” Cumulocity processing mode β€” set the Cumulocity processing mode ✨

🧬 OPTIONS INHERITED FROM PARENT COMMANDS 🧬

  • --abortOnErrors=10 β€” Abort batch when reaching specified number of errors β€” batch says bye at that error count 😭
  • --allowEmptyPipe[=false] β€” Don't fail when piped input is empty (stdin) β€” empty pipe? not a crisis, allegedly 🫢
  • --cache[=false] β€” Enable cached responses β€” cache girlies rise πŸ’…
  • --cacheBodyPaths=[] β€” Cache should limit hashing of selected paths in the json body. Empty indicates all values β€” empty means all values, iykyk πŸŽ€
  • --cacheTTL="60s" β€” Cache time-to-live (TTL) as a duration, i.e. 60s, 2m β€” how long the cache stays iconic ⏳
  • -c, --compact[=false] β€” Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal β€” terminal gets pretty, non-terminal gets compact ✨
  • --confirm[=false] β€” Prompt for confirmation β€” are you sure, bestie? πŸ‘€
  • --confirmText="" β€” Custom confirmation text β€” make the "u sure?" text your own πŸŽ€
  • --currentPage=0 β€” Current page which should be returned β€” page number go brrr πŸ“„
  • --customQueryParam=[] β€” add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' β€” custom query params, slay πŸ”₯
  • --debug[=false] β€” Set very verbose log messages β€” verbose with a capital V, bestie πŸ—£οΈ
  • --delay="0ms" β€” delay after each request, i.e. 5ms, 1.2s β€” chill after each request 😌
  • --delayBefore="0ms" β€” delay before each request, i.e. 5ms, 1.2s β€” chill before each request 😌
  • --dry[=false] β€” Dry run. Don't send any data to the server β€” pretend mode, zero server drama πŸ™ˆ
  • --dryFormat="markdown" β€” Dry run output format. i.e. json, dump, markdown or curl β€” pick your dry-run aesthetic πŸ’…
  • --examples[=false] β€” Show examples for the current command β€” show me the receipts, bestie πŸ“Έ
  • --filter=[] β€” Apply a client side filter to response before returning it to the user β€” client-side filter before it hits you ✨
  • --flatten[=false] β€” flatten json output by replacing nested json properties with properties where their names are represented by dot notation β€” nested json? flattened with dot notation, periodt 🫢
  • -f, --force[=false] β€” Do not prompt for confirmation. Ignored when using --confirm β€” no prompt, but --confirm wins πŸ‘‘
  • -H, --header=[] β€” custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue" β€” custom headers, very main character πŸ’…
  • --includeAll[=false] β€” Include all results by iterating through each page β€” all pages, all results, all vibes 🌈
  • -k, --insecure[=false] β€” Allow insecure server connections when using SSL β€” insecure SSL connections, proceed with awareness 😬
  • -l, --logMessage="" β€” Add custom message to the activity log β€” put your lil note in the activity log πŸŽ€
  • --maxJobs=0 β€” Maximum number of jobs. 0 = unlimited (use with caution!) β€” unlimited jobs, use with caution, bestie 😭
  • --noAccept[=false] β€” Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect β€” PUT and POST only see the effect πŸ‘€
  • --noCache[=false] β€” Force disabling of cached responses (overwrites cache setting) β€” cache off, no arguments πŸ’…
  • -M, --noColor[=false] β€” Don't use colors when displaying log entries on the console β€” no console color for log entries 🎨
  • --noLog[=false] β€” Disables the activity log for the current command β€” activity log? not today πŸ™…β€β™€οΈ
  • --noProgress[=false] β€” Disable progress bars β€” no progress bars, just vibes πŸ¦‹
  • --noProxy[=false] β€” Ignore the proxy settings β€” proxy settings ignored, periodt 🫢
  • -n, --nullInput[=false] β€” Don't read the input (stdin). Useful if using in shell for/while loops β€” no stdin, great for shell for/while loops πŸ”
  • -o, --output="table" β€” Output format i.e. table, json, csv, csvheader β€” choose your output format, icon πŸ’…
  • --outputFile="" β€” Save JSON output to file (after select/view) β€” save JSON after select/view πŸ’Ύ
  • --outputFileRaw="" β€” Save raw response to file (before select/view) β€” save raw before select/view πŸ’Ύ
  • --outputTemplate="" β€” jsonnet template to apply to the output β€” jsonnet template moment ✨
  • -p, --pageSize=5 β€” Maximum results per page β€” max results per page, keep it cute πŸ“„
  • --progress[=false] β€” Show progress bar. This will also disable any other verbose output β€” progress bar on, other verbose output off πŸ“Š
  • --proxy="" β€” Proxy setting, i.e. http://10.0.0.1:8080 β€” proxy setting, bestie 🌐
  • -r, --raw[=false] β€” Show raw response. This mode will force output=json and view=off β€” raw response forces output=json and view=off, no cap πŸ”₯
  • --retries=3 β€” Max number of attempts when a failed http call is encountered β€” failed http call? try again, up to 3 🫢
  • --select=[] β€” Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' β€” pick properties, wildcards and globstar accepted πŸ’…
  • --session="" β€” Session configuration β€” session configuration, slay πŸŽ€
  • --sessionMode="" β€” Override default session mode for a single command which would normally be disabled β€” override session mode for one command πŸ‘‘
  • -P, --sessionPassword="" β€” Override session password β€” override session password, secret secret 🀫
  • -U, --sessionUsername="" β€” Override session username. i.e. peter or t1234/peter (with tenant) β€” override session username, with tenant option 🫢
  • --silentExit[=false] β€” Silent status codes do not affect the exit code β€” silent status codes don't touch exit code 🀐
  • --silentStatusCodes="" β€” Status codes which will not print out an error message β€” these status codes won't print an error message πŸ™ˆ
  • --timeout="600s" β€” Request timeout duration, i.e. 60s, 2m β€” request timeout duration, clock is ticking ⏰
  • --totalPages=0 β€” Total number of pages to get β€” total pages to get, page girlies unite πŸ“š
  • -v, --verbose[=false] β€” Verbose logging β€” verbose logging, tell me everything πŸ—£οΈ
  • --view="auto" β€” Use views when displaying data on the terminal. Disable using --view off β€” views on terminal, disable with --view off ✨
  • --withError[=false] β€” Errors will be printed on stdout instead of stderr β€” errors to stdout instead of stderr πŸ‘€
  • --withTotalElements[=false] β€” Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13) β€” total elements under .statistics.totalElements, introduced in 10.13 πŸŽ€
  • -t, --withTotalPages[=false] β€” Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages β€” total pages under .statistics.totalPages πŸ“„
  • --workers=1 β€” Number of workers β€” worker count, bestie πŸ‘·β€β™€οΈ

🌈 EXAMPLE 🌈

$ c8y retentionrules delete --id 12345
Delete a retention rule

πŸ‘‘ SEE ALSO πŸ‘‘

c8y-retentionrules(1) β€” go check out the parent-command vibes, iykyk 🫢


later, bestie! β€” c8y(1), Jan 1980 edition πŸŽ€βœ¨

πŸ“¦ where this page comes from