c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y — devicegroups children, bestie edition ✨

okay so like. welcome to the c8y manual page, specifically the c8y-devicegroups-children corner of it, and honestly? it's giving "small command, huge inheritance" 💀. the manual name is c8y (section 1) and we're deep in the c8y devicegroups children subcommand. buckle up 🎀

✨ NAME ✨

c8y-devicegroups-children — Cumulocity managed object child references</p> 🦋

like, the child refs of a managed object. that's the whole vibe. iykyk.

✨ SYNOPSIS ✨

c8y devicegroups children [flags]

that's it. that's the whole thing. a command and some flags, no positional args to worry about 🫶

✨ DESCRIPTION ✨

Manage child entities (assets, additions and device) for device groups 🌸

so like — a device group has children, and the children can be assets, additions, or device. this command is your girl for managing those. no cap. 👑

✨ OPTIONS ✨

  • -h, --help[=false] — help for children 🥺 the classic "what does this do again" button.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

okay bestie, THIS is the part. everything below is inherited from the parent commands, which means you get all of it for free and there is a lot of it. literally 56 flags. main character energy fr fr 🔥

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. like, ten strikes and the batch is out 💀
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). empty pipe? no drama. 🫶
  • --cache[=false] — Enable cached responses. speed ✨
  • --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. (terminal = pretty, file = compact, she's flexible 💅)
  • --confirm[=false] — Prompt for confirmation.
  • --confirmText="" — Custom confirmation text. make it say something cute 🎀
  • --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. very verbose. she's not shy 😭
  • --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. pretend mode 🧚
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl
  • --examples[=false] — Show examples for the current command. obsessed with this one ngl ✨
  • --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 the ignoring, it's a real thing.
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — Include all results by iterating through each page. all of it. every page. 🌀
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. 🚨 insecure is literally in the name, bestie, be careful.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). 🔥 and they MEANT that caution.
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. (yes, only PUT and POST see the effect — that's the fact, don't come for me)
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting).
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. sad beige logs 😔
  • --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. 🫶 lifesaver honestly
  • -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. no notes 💅
  • --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.

🌸 SEE ALSO 🌸

go look at her sisters, they're all iconic in their own way 💖

and that's the page!! mwah 💋 this little beauty is dated Jan 1980 (yes really, she's vintage and she's still slaying ✨) and it's the c8y(1) manual, section one, no cap. go forth and manage those children, bestie 🎀🦋👑

📦 where this page comes from