c8y(1)

📦 version 2.56.1, in nixpkgs unstable

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

okay bestie, so this is the manual page for c8y — yes, THE c8y — and we're starting with the little c8y-inventory-parents-get corner of it. Strap in, it's giving "one command, four billion inherited flags" energy 😭✨

🌸 NAME

c8y-inventory-parents-get — get the managed object's parent 🫶

✨ SYNOPSIS

c8y inventory parents get [flags]

🦋 DESCRIPTION

You want to know who a managed object's parent is? Say less 💅 This grabs the parent for whatever relationship types you name — like addition, asset, or device, iykyk.

🎀 OPTIONS

  • --all[=false] — give me every parent in the chain, no cap 👑
  • -h, --help[=false] — shows the help for get, bless 🫶
  • --id=[] — the ManagedObject id, and yes it's required (accepts pipeline) ⭐
  • --level=1 — how many parent jumps you wanna do. 0 = the current item, 1 = parent, 2 = grandparent, etc. Defaults to 1. Use -1 for the last parent 🌈
  • --reverse[=false] — return all the parents in order from root → parent, iconic flip 🔄
  • --type="" — the relationship type, like addition, asset, device 🦋

💖 OPTIONS INHERITED FROM PARENT COMMANDS

these are the lil hand-me-downs from the parent commands, and there are so many of them, but we respect them 💜

  • --abortOnErrors=10 — bails the whole batch once you hit that many errors, dramatic but fair 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty, be nice 🙈
  • --cache[=false] — turns on cached responses ⚡
  • --cacheBodyPaths=[] — the cache should only hash selected paths in the json body; empty means all values 🔍
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m ⏳
  • -c, --compact[=false] — compact output instead of pretty-printed when using json output. Pretty print is the default if the output is the terminal ✨
  • --confirm[=false] — prompts you for confirmation 🫶
  • --confirmText="" — your own custom confirmation text, make it cute 💅
  • --currentPage=0 — which page should be returned 📄
  • --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' 🔧
  • --debug[=false] — sets VERY verbose log messages, buckle up 📢
  • --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 🚫
  • --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 the response before it gets back to you 🧚
  • --flatten[=false] — flattens json output by replacing nested json properties with properties whose names are dot notation 🪄
  • -f, --force[=false] — don't prompt for confirmation. Ignored when using --confirm ⚠️
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue" 📨
  • --includeAll[=false] — include all results by iterating through each page 🔁
  • -k, --insecure[=false] — allow insecure server connections when using SSL 🙈
  • -l, --logMessage="" — add a custom message to the activity log 🗒️
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) 💀
  • --noAccept[=false] — ignore the Accept header, which removes the Accept header from requests; however PUT and POST requests will only see the effect 🚫
  • --noCache[=false] — force disabling of cached responses (overwrites the cache setting) 🧊
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console 🎨
  • --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 you're using 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 the 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 the 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 the raw response. This mode will force output=json and view=off 🥩
  • --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 the default session mode for a single command which would normally be disabled 🎛️
  • -P, --sessionPassword="" — override the session password 🔒
  • -U, --sessionUsername="" — override the 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 👷‍♀️

🔥 EXAMPLE

lowkey the best part, here's how you'd actually use it:

$ c8y inventory parents get --id 12345 --type addition

get the parent of the child addition 💫

$ c8y inventory parents get --id 12345 --type asset

get the parent of the child asset (which is e.g. usually the group) 🎀

$ c8y devices list | c8y inventory parents get --type device --level 2

get the grandparent (parent of the parent) 👑

$ c8y devices list | c8y inventory parents get --type device --level -1

get the root parent device of a list of devices 🌳

$ c8y devices get --id 12345 | c8y inventory parents get --type device -all

get all parents (parent, grandparents, grandparents etc.) of a single device, returning the root parent last 🏁

$ c8y devices get --id 12345 | c8y inventory parents get --type device -all --reverse

get all parents (parent, grandparents, grandparents etc.) of a single device, returning the root parent first 🥇

🧚 SEE ALSO

c8y-inventory-parents(1) — go read the rest of the family, they're all slaying 💅

and that's the whole page bestie!! 🎉 this one's dated Jan 1980 (yes, literally, don't ask 😭) and it's the c8y manual, page c8y(1), mwah 💋✨🦋

📦 where this page comes from