c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y manual, but make it make sense

okay so bestie, welcome to c8y — the command-line bestie you didn't know you needed. this page is the c8y(1) manual, and today's main character is one specific subcommand. buckle up, it's giving "powerful tool, slightly intimidating flags", but we're gonna slay it together fr fr. 🦋

✨ NAME ✨

c8y-deviceprofiles-create — create a device profile. that's it. that's the vibe. 💅

🎀 SYNOPSIS 🎀

c8y deviceprofiles create [flags]

literally just that. short, sweet, iconic. 👑

🌸 DESCRIPTION 🌸

It creates a new device profile (a managedObject, iykyk). Think of it as making a fresh little template soul for your devices to be matched against. no cap, that's the whole thing. ✨

💖 OPTIONS 💖

okay here's the good stuff — these are the flags that live just on create:

  • -d, --data=[] — static data that gets applied to the body. accepts json, or that cute shorthand json like --data 'value1=1,my.nested.value=100'. 🍓
  • --deviceType="" — device type filter. only lets this device profile be applied to devices of this type. picky on purpose, we love boundaries. 💅
  • -h, --help[=false] — help for create. the classic. 🙈
  • --name="" — the name. (it accepts pipeline input, so you can pipe it in like the icon you are) 🎀
  • --processingMode="" — Cumulocity processing mode. 🌈
  • --template="" — body template. ✨
  • --templateVars=[] — body template variables. 🧚

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the flags you get for free because your parent command said "here bestie, take these". there are like fifty of them. we're listing all of them. no skipping. periodt. 💀

  • --abortOnErrors=10 — abort the batch once you hit the specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty.
  • --cache[=false] — enable cached responses.
  • --cacheBodyPaths=[] — cache should limit hashing to selected paths in the json body. empty means 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 the 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 a custom message to the activity log.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!).
  • --noAccept[=false] — ignore Accept header, which 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.
bestie please note: --maxJobs=0 says "unlimited (use with caution!)" and it means it. don't come crying to me when you fire off a billion jobs. 😭

🔥 EXAMPLE 🔥

here's literally the example, chef's kiss:

$ c8y deviceprofiles create --name "python3-requests"
Create a device profile

that's it. that's the whole flex. ate and left no crumbs. 💅

🫶 SEE ALSO 🫶

and that's the page! ✨ cute sign-off time: this little love letter comes from the c8y manual, dated Jan 1980 (yes, really, she's vintage 💜). now go forth and create device profiles, you absolute icon. 🎀🦋👑

📦 where this page comes from