c8y(1)

📦 version 2.56.1, in nixpkgs unstable

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

okay bestie, buckle up 🎀 this is the manual page for c8y (that's the command you're holding in your hands rn), and specifically we're zooming in on the c8y-inventory-children corner of the universe. no cap, it's a whole vibe.

✨ NAME ✨

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

like, it's the whole thing about the children of your managed objects. found family, but for assets.

🌸 SYNOPSIS 🌸

c8y inventory children [flags]

that's it. that's the whole invocation. short, iconic, to the point. 👑

💖 DESCRIPTION 💖

Manage child entities (assets, additions and device) for managed objects.

fr fr, that's the job — you've got a managed object, and it has children: assets, additions, and device. this command is your little group chat for managing those child references. main character energy for delegation. 🫶

🔥 OPTIONS 🔥

  • -h, --help[=false] — help for children. yes, the help has help. very meta of it. 💅

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

so these bad boys come from the parent command — you didn't have to define them, they're just passed down like family recipes. 🍓

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. lowkey a safety net, ngl.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). no input? no problem, bestie.
  • --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. it's giving "minimalist era".
  • --confirm[=false] — Prompt for confirmation.
  • --confirmText="" — Custom confirmation text. make it say what you want. 🎀
  • --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 "tell me 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. rehearse the slay before you actually slay 💅
  • --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. nested? not anymore bestie.
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. bold of you, love that for you.
  • -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 crumb. 🍓
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. > girl, this is insecure fr — only do it when you know what you're doing.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). literally unlimited. caution, babe. ⚠️
  • --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 output 🥲
  • --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. five at a time, keep it cute. ✨
  • --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 filter, no makeup, just raw. 💀
  • --retries=3 — Max number of attempts when a failed http call is encountered. three strikes, but make it networking.
  • --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. she's chatty and we love her.
  • --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. one worker = one bestie doing her best 🫶

🦋 SEE ALSO 🦋

the whole friend group, go say hi:

okay that's the whole page, bestie, you ate that 💅✨ this edition of the c8y(1) manual is dated Jan 1980 (yes, really, she's vintage 👑) — go forth, manage those children entities, and remember: no cap, only facts. 🎀🌈💖

📦 where this page comes from