c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y girlie's field guide 🎀

okay so bestie, welcome to the c8y manual page, like the actual one, and yes it's giving "I read the whole thing so you don't have to" energy. we're doing this together, you and me, no cap ✨

🌸 NAME 🌸

c8y-deviceprofiles-update — Update device profile

🦋 SYNOPSIS 🦋

c8y deviceprofiles update [flags]

💖 DESCRIPTION 💖

Update an existing device profile (managedObject). that's it, that's the whole vibe. you're going in and editing something that already exists — no creating, just glow-up energy 💅

✨ OPTIONS ✨

  • -d, --data=[] — static data to be applied to body. it accepts json or shorthand json, so like --data 'value1=1,my.nested.value=100' — yes bestie, the dot notation is the moment 🫶
  • --deviceType="" — Device type filter. only lets the device profile be applied to devices of this type. gatekeeping, but make it functional 💀
  • -h, --help[=false] — help for update. when in doubt, ask for help, it's literally self care 🌸
  • --id=[] — Device profile (managedObject) id — required — and it accepts pipeline. this is the main character flag, don't forget it 🔥
  • --newName="" — New device profile name. a rebrand, if you will 👑
  • --processingMode="" — Cumulocity processing mode
  • --template="" — Body template
  • --templateVars=[] — Body template variables

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the flags you get handed down from the parent command, like family heirlooms but for CLI, and honestly they ate 🍓

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. ten strikes and the batch is out ✋
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). empty pipe? we simply allow it, no drama 💜
  • --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 — so yes, when it's a real terminal you get the pretty version, iykyk
  • --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. the "I want to know EVERYTHING" setting 🔍
  • --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. rehearsal era 🎭
  • --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. note that: ignored, periodt.
  • -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 single one 🫶
  • -k, --insecure[=false] — Allow insecure server connections when using SSL
  • -l, --logMessage="" — Add custom message to the activity log
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!) — and bestie, they put the caution there for a REASON 😭
  • --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. monochrome moment 💀
  • --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. raw and unfiltered, we love that for you 🌈
  • --retries=3 — Max number of attempts when a failed http call is encountered. three tries, then we accept fate 🙈
  • --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. talk to me, bestie 🗣️
  • --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 deviceprofiles update --id 12345 --newName "my_custom_name" --data "{\"com_my_props\":{},\"value\":1}"
Update a device profile

look at her go. iconic behavior honestly 👑

🧚 SEE ALSO 🧚

ngl bestie, the --id flag is required, so like… don't skip it. that's the one thing that'll actually ruin your day 😭

and that's the whole page! this little beauty comes to you from the Jan 1980 edition of the c8y docs — yes, the date really says that, and honestly? retro icon behavior 🎀✨ stay slay, stay updated, and may all your device profiles be exactly as you named them 💅🦋

📦 where this page comes from