c8y(1)

📦 version 2.56.1, in nixpkgs unstable

c8y(1) — the c8y configuration delete glow-up ✨

okay so bestie, welcome to c8y(1) 😌 this is the page for c8y configuration delete, aka the little command that says bye-bye to a configuration file. stick with me, it's actually so good.

💅 NAME 💅

c8y-configuration-delete — literally just: delete a configuration file. that's the whole vibe.

🦋 SYNOPSIS 🦋

c8y configuration delete [flags]

like, that's it. that's the whole incantation. flags do the heavy lifting, iykyk.

🌸 DESCRIPTION 🌸

so the one job here is deleting an existing configuration file. that's the assignment, and it ate. no cap.

✨ OPTIONS ✨

these are the flags that belong to delete itself, bestie. read them, love them, use them responsibly 💖

  • --forceCascade[=true] — nukes the version and any related binaries along with it. full cascade situation.
  • -h, --help[=false] — help for delete. your little safety blanket 🫶
  • --id=[] — the configuration file (managedObject) id. required, babes, no skipping. also accepts pipeline.
  • --processingMode="" — the Cumulocity processing mode. fancy.

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the ones you didn't ask for but got anyway, like a goodie bag from the parent command. all of them, in order, zero skipped 🎀

  • --abortOnErrors=10 — abort the batch once you hit the specified number of errors. it's giving "we're done here".
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. be nice about it.
  • --cache[=false] — enable cached responses. speed ✨
  • --cacheBodyPaths=[] — the cache should limit hashing to selected paths in the json body. empty means all values, i.e. hash everything, go off.
  • --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. ngl, pretty print is the default if output is the terminal.
  • --confirm[=false] — prompt for confirmation. consent era 💅
  • --confirmText="" — your own custom confirmation text. make it cute.
  • --currentPage=0 — the 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. chaos mode, but productive.
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s.
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. yes it's a different one, don't @ me.
  • --dry[=false] — dry run. don't send any data to the server. window shopping energy 🛍️
  • --dryFormat="markdown" — dry run output format. i.e. json, dump, markdown or curl.
  • --examples[=false] — show examples for the current command. love a demo.
  • --filter=[] — apply a client side filter to the response before returning it to the user. gatekeeping, but for data.
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. it's giving flat-lay.
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. read that twice.
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — include all results by iterating through each page. all of them. every last one.
  • -k, --insecure[=false] — allow insecure server connections when using SSL. proceed with caution, bestie 😭
  • -l, --logMessage="" — add a custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution! ⚠️ it said it, not me).
  • --noAccept[=false] — ignore the Accept header, which removes the Accept header from requests. however, PUT and POST requests will only see the effect.
  • --noCache[=false] — force disabling of cached responses (overwrites the cache setting).
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome moment.
  • --noLog[=false] — disables the activity log for the current command.
  • --noProgress[=false] — disable progress bars. no little spinner for you.
  • --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 the raw response to file (before select/view). different file, different moment in the pipeline, keep up 💖
  • --outputTemplate="" — jsonnet template to apply to the output.
  • -p, --pageSize=5 — maximum results per page.
  • --progress[=false] — show the progress bar. this will also disable any other verbose output. pick a lane.
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080
  • -r, --raw[=false] — show the raw response. this mode will force output=json and view=off.
  • --retries=3 — max number of attempts when a failed http call is encountered. keep trying, king.
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'
  • --session="" — session configuration.
  • --sessionMode="" — override the default session mode for a single command, which would normally be disabled.
  • -P, --sessionPassword="" — override the session password.
  • -U, --sessionUsername="" — override the 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. the girlies love a paper trail.
  • --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. spicy redirect.
  • --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 live demonstration, watch closely 🔥

$ c8y configuration delete --id 12345
Delete a configuration package (and any related binaries)

that one's the full send — package and its related binaries, gone, periodt.

$ c8y configuration delete --id 12345 --forceCascade=false
Delete a configuration package but keep any related binaries

and this one? the configuration package dips, but the related binaries stay. selective deletion, we love a boundaries queen 🫶

🌈 SEE ALSO 🌈

c8y-configuration(1)</purl> — go read the parent page, bestie, it's the whole family tree.

lowkey reminder before you go: --force is ignored when you're using --confirm, --maxJobs=0 means unlimited (and it literally said "use with caution!"), and --noAccept only really shows up on PUT and POST. i don't make the rules, i just report them 💀

and that's the page!! 💖 written under c8y(1), dated Jan 1980 (she's vintage, she's iconic, she's timeless 👑), from the source/version line at the bottom. mwah, go delete something responsibly 🎀

📦 where this page comes from