c8y(1)

Hey bestie 💖 you’re reading the c8y(1) manual page for c8y-devices-children-get, and we are absolutely gonna get you that child, no cap.

✨ NAME ✨

c8y-devices-children-get — get a child 🎀

🌸 SYNOPSIS 🌸

c8y devices children get [flags]

🦋 DESCRIPTION 🦋

Get a child of a device. That’s the whole vibe, bestie 💅

💖 OPTIONS 💖

• --child=[] — child managed object id, and yes it’s required 👑
• --childType="" — child relationship type, also required ✨
• -h, --help[=false] — help for get 🫶
• --id=[] — managed object id, required, and it accepts pipeline input 🌈

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

• --abortOnErrors=10 — abort the batch when you hit the specified number of errors 💀
• --allowEmptyPipe[=false] — don’t fail when the piped input from stdin is empty 🎀
• --cache[=false] — enable cached responses ✨
• --cacheBodyPaths=[] — cache should limit hashing of 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 instead of pretty-printed output when using json output; pretty print is the default if output is the terminal 💅
• --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' 🔥
• --debug[=false] — set very verbose log messages 👀
• --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 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 ⚠️
• -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 custom message to the activity log 🗒️
• --maxJobs=0 — maximum number of jobs; 0 = unlimited (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 🚨
• --noCache[=false] — force disabling of cached responses (overwrites 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 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 📑
• --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 🥩
• --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 🛠️

🌟 EXAMPLE 🌟

Run it like this, bestie:

$ c8y devices children get --id 12345 --child 12345 --childType addition
Get an existing child addition reference

🎀 SEE ALSO 🎀

• c8y-devices-children(1) — go see the parent command, iykyk 🫶

That’s the whole manual page, bestie — c8y(1), Jan 1980, byeee 💋