c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y — the c8y manual page, bestie edition 🎀

okay so you opened the c8y manual, specifically the page for c8y-devices-children, and honestly? iconic choice. we're doing child references today and I'm gonna walk you through every single flag like your favorite study buddy who actually read the docs. no gatekeeping, periodt. ✨

🌸 NAME 🌸

c8y-devices-children — Cumulocity managed object child references 🦋

like, it's the part of c8y that deals with the child refs hanging off your managed objects. that's the whole vibe.

✨ SYNOPSIS ✨

c8y devices children [flags]

short, sweet, slay. c8y devices children plus whatever flags you feel like throwing at it. 💅

💖 DESCRIPTION 💖

Manage child entities (assets, additions and device) for devices 🫶

that's it, that's the job — you're managing the children of devices: assets, additions and device. think of it as family-tree maintenance but for your Cumulocity device inventory. no cap.

🔥 OPTIONS 🔥

here's the local menu, all two of them, still iconic:

  • -h, --help[=false] — help for children. the "wait what does this even do" button 💫

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

okay bestie, this is the big one. everything below gets handed down from the parent command, so it works here too. grab a snack, this list is a whole journey 🍓

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. like a "three strikes" rule but you pick the number, default's 10.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). empty pipe? not a crisis. 💜
  • --cache[=false] — Enable cached responses.
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. so leave it empty and it's hashing everything, understood? 💅
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. default is "60s".
  • -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 the glow-up, pipes get the compact version ✨
  • --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'. go off, add your own params 🎀
  • --debug[=false] — Set very verbose log messages. chaos mode but productive.
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. default "0ms".
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. default "0ms".
  • --dry[=false] — Dry run. Don't send any data to the server. pretend mode, zero consequences 🫶
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. default's "markdown".
  • --examples[=false] — Show examples for the current command. yes queen, show me the examples.
  • --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. nested? not anymore 💫
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. note that little caveat, bestie — --confirm wins.
  • -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 page. 🌈
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. ⚠️ your call, but like, be aware.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). the manpage literally said "use with caution" so I'm saying it too, fr fr 💀
  • --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. 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. loop girlies rise 🧚
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. default "table".
  • --outputFile="" — Save JSON output to file (after select/view).
  • --outputFileRaw="" — Save raw response to file (before select/view). yes, "before" — that's the whole difference, don't mix them up 💅
  • --outputTemplate="" — jsonnet template to apply to the output.
  • -p, --pageSize=5 — Maximum results per page. default 5.
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. trade-off, bestie.
  • --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. it overrides stuff, just so you know 👀
  • --retries=3 — Max number of attempts when a failed http call is encountered. default 3, we try again, we don't give up 💪
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. this one's a personal fave ⭐
  • --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. default "600s".
  • --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. default "auto".
  • --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. default 1, multiply responsibly 🔥
real talk: --insecure disables SSL verification, --maxJobs=0 is unlimited and the page itself says "use with caution!" — so like, know what you're doing, bestie. 🫶

🦋 SEE ALSO 🦋

go read these next, they're all in the family:

and that's the whole page, bestie 💖 this was c8y(1) — dated Jan 1980 (yes really, vintage icon behavior 👑) — go forth and manage those children, mwah 🎀

📦 where this page comes from