c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 NAME 💖

okay bestie, this is the c8y(1) manual page — section 1, command-line central — and today’s main character is c8y-firmware-patches-create: Create firmware patch. It’s giving “new managedObject” energy, fr fr. 💅✨

🦋 SYNOPSIS 🦋

c8y firmware patches create [flags]

Like, that’s the whole shape of it: you run c8y with firmware patches create, and then you sprinkle on [flags] as needed. 🎀

🌸 DESCRIPTION 🌸

Create a new firmware patch (managedObject). That’s the tea, bestie — this command makes a fresh firmware patch and that’s literally it. 🫶

✨ OPTIONS ✨

  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'. Drop your body data here, bestie 💅
  • --dependencyVersion="" — Existing firmware version that the patch is dependent on. It’s the “my patch depends on this version” vibe 🫶
  • --file="" — File to be uploaded. Yes, the actual file, no cap 📁
  • --firmware=[] — Firmware package id where the version will be added to (accepts pipeline). Pipeline girlies rise 🌈
  • -h, --help[=false] — help for create. The classic “what does this do again” button 🎀
  • --processingMode="" — Cumulocity processing mode.
  • --template="" — Body template. For when you want the body to have main character template energy ✨
  • --templateVars=[] — Body template variables.
  • --url="" — URL to the firmware patch. Link it up 🔗
  • --version="" — Patch version, i.e. 1.0.0. Version numbers are iconic, periodt 👑

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

These bad boys come from the parent command — still iconic, still yours, still very much part of the group chat. 🫶

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. Default vibes: 10, so it bails after that many errors unless you say otherwise 💀
  • --allowEmptyPipe[=false] — Don’t fail when piped input is empty (stdin). Empty pipe? Not today, bestie 🎀
  • --cache[=false] — Enable cached responses.
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. It’s giving selective hashing 👀
  • --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. Smol output rights 💅
  • --confirm[=false] — Prompt for confirmation.
  • --confirmText="" — Custom confirmation text. Make your confirmation ask cute 🎀
  • --currentPage=0 — Current page which should be returned.
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Custom query param slay 🌈
  • --debug[=false] — Set very verbose log messages. This is the “tell me EVERYTHING” mode 💀
  • --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. No data goes out, bestie — it’s a rehearsal 🎭
  • --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. Dot notation girlies, this one’s for you 🦋
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. Important caveat, bestie — --confirm wins here 💅
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue".
  • --includeAll[=false] — Include all results by iterating through each page. Page-by-page until the end, periodt 🎀
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. This is the risky one, bestie — insecure SSL connections are exactly what they sound like. 🚨
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). Use with caution! That’s not me being dramatic, that’s the page 💀
  • --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 🎀

First one, bestie — a patch with an external URL:

$ c8y firmware patches create --firmware "UBUNTU_20_04" --version "20.4.1" --dependencyVersion "20.4.0" --url "https://example.com/binary/12345

Create a new patch (with external URL) to an existing firmware version.

Next up — storing the file in Cumulocity:

$ c8y firmware patches create --firmware custom\ firmware\ 1 --dependencyVersion 2.2.0 --version 2.2.1 --file ./install.ps1

Create a new patch (storing the file in Cumulocity) to an existing firmware version.

And the empty-version-and-url vibe:

$ c8y firmware patches create --firmware 12345 --dependencyVersion 2.2.0

Create a new patch with an empty version number and url.

🌈 SEE ALSO 🌈

c8y-firmware-patches(1) — go read that one next, bestie. It’s the parent-command family reunion 🫶

✨ That’s the whole c8y(1) page, bestie — footer/source-version vibes say Jan 1980, and the manual is c8y(1). Now go create those firmware patches and slay. 💖💅🎀

📦 where this page comes from