c8y(1)

📦 version 2.56.1, in nixpkgs unstable

c8y(1) — c8y-devicegroups-create 💅

okay bestie, welcome to the c8y-devicegroups-create page from the c8y(1) manual. This is the one for making a new device group so devices can be logically grouped together. main character energy for your devices, honestly. 🦋

🌸 NAME 🌸

c8y-devicegroups-create — Create device group. that's the whole name tag, periodt. 💖

✨ SYNOPSIS ✨

c8y devicegroups create [flags]

run it with flags, bestie. no cap. 🫶

🦋 DESCRIPTION 🦋

Create a new device group to logically group one or more devices. it's giving organization, it's giving folder energy, it's giving “my devices are not just vibing everywhere”. 🌈

🎀 OPTIONS 🎀

  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'. shorthand json is lowkey iconic. ✨
  • -h, --help[=false] — help for create. the classic “pls explain” button. 💅
  • --name="" — Device group name (accepts pipeline). it literally accepts pipeline, bestie. 🫶
  • --processingMode="" — Cumulocity processing mode. very official, very slay. 👑
  • --template="" — Body template. the template for the body, bestie. 🎀
  • --templateVars=[] — Body template variables. plural variables, plural vibes. 🦋
  • --type="" — Device group type (c8y_DeviceGroup (root folder) or c8y_DeviceSubGroup (sub folder)). Defaults to c8y_DeviceGroup. root folder or sub folder, choose your fighter. 🌸

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. like, stop the batch when the error count hits the limit. 💀
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). empty pipe? no dramatic failure, bestie. 🫶
  • --cache[=false] — Enable cached responses. cache mode: on. ✨
  • --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. duration core. ⭐
  • -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 print by default, no cap. 🍓
  • --confirm[=false] — Prompt for confirmation. the “are you sure, bestie?” vibe. 🙈
  • --confirmText="" — Custom confirmation text. write your own confirmation moment. 💖
  • --currentPage=0 — Current page which should be returned. page zero, starting strong. 🦋
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. custom query param era. 🌈
  • --debug[=false] — Set very verbose log messages. very verbose. very “what is happening”. 💀
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. a lil pause after each request. 🎀
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. a lil pause 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 format, bestie. 💅
  • --examples[=false] — Show examples for the current command. show me the examples, pls. 🌸
  • --filter=[] — Apply a client side filter to response before returning it to the user. client-side filter before it comes back to you. ⭐
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested json gets dot-notation-ified. 🦋
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. no prompt — but --confirm wins if both show up. ⚠️
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". custom headers, custom vibe. 💅
  • --includeAll[=false] — Include all results by iterating through each page. every page gets iterated, bestie. 🫶
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. SSL but insecure connections allowed. 🙈
  • -l, --logMessage="" — Add custom message to the activity log. drop a custom message in the activity log. 🎀
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). unlimited jobs — the page literally says use with caution! 💀
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. the Accept header gets removed, but PUT and POST only see the effect. 🦋
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). cache off, and it overwrites the cache setting. ✨
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. no colors in console log entries. 💅
  • --noLog[=false] — Disables the activity log for the current command. activity log: off for this command. 🫶
  • --noProgress[=false] — Disable progress bars. no progress bars, no distractions. ⭐
  • --noProxy[=false] — Ignore the proxy settings. proxy settings? ignored. 🌸
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. no stdin reading — handy in shell for/while loops. 🦋
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. table is the default, but json/csv/csvheader are right there. 💖
  • --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 response before select/view. ✨
  • --outputTemplate="" — jsonnet template to apply to the output. jsonnet template moment. 🦋
  • -p, --pageSize=5 — Maximum results per page. five results per page by default. 🍓
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. progress bar on — and it also disables other verbose output. 💅
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. proxy setting, exact example included. 🌈
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. raw mode forces output=json and view=off. ⚠️
  • --retries=3 — Max number of attempts when a failed http call is encountered. three attempts when an http call fails. 🫶
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. wildcards and globstar accepted, bestie. ⭐
  • --session="" — Session configuration. session config. 💖
  • --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. session password override. 🎀
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). username override, tenant style included. 💅
  • --silentExit[=false] — Silent status codes do not affect the exit code. silent status codes don't touch the 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 — exact examples included. 🌸
  • --totalPages=0 — Total number of pages to get. total pages to get. 🦋
  • -v, --verbose[=false] — Verbose logging. verbose logging, very chatty. 💅
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. views on the terminal, disable with --view off. ⭐
  • --withError[=false] — Errors will be printed on stdout instead of stderr. errors go 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 in the response stats 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 in the response stats under .statistics.totalPages. 🌈
  • --workers=1 — Number of workers. one worker by default. 🫶

🎀 EXAMPLE 🎀

the page gives these two exact runs, bestie:

$ c8y devicegroups create --name mygroup
Create device group

$ c8y devicegroups create --name mygroup --data "custom_value1=1234"
Create device group with custom properties

first one: name only. second one: name plus custom properties. iconic behavior. 💖

🌸 SEE ALSO 🌸

💖 okay that's the whole page — source/version c8y(1), date Jan 1980. stay iconic, bestie! 🫶

📦 where this page comes from