c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y — the c8y(1) manual, bestie edition 🎀

okay so you're looking at c8y(1) — that's the manual name, that's the whole vibe, we're in it. this page is about the c8y command line, specifically one lil subcommand that plays matchmaker between managed objects. let's go 🌸

✨ NAME ✨

c8y-devices-children-assign — Assign child 🫶

🌈 SYNOPSIS 🌈

🦋 DESCRIPTION 🦋

Assign an existing managed object as a child to an existing managed object. that's it. that's the whole thing. two managed objects walk in, one walks out as the other's child. literally family tree construction, no cap 👑

💜 OPTIONS 💜

  • --child="" — the managed object that will be assigned as a child. required, bestie, you cannot skip it. it also accepts pipeline 🧚
  • --childType="" — the child relationship type. required too. name the relationship, don't leave it situationship-status 💀
  • -h, --help[=false] — help for assign. your little emergency exit when you're lost 🎀
  • --id=[] — the managed object id where the child will be assigned to. required. this is the parent, the main character 👑
  • --processingMode="" — Cumulocity processing mode ⭐

🌸 OPTIONS INHERITED FROM PARENT COMMANDS 🌸

these are the flags you didn't ask for but got anyway — inherited from the parent, like your mom's anxiety. except these are useful 💅

  • --abortOnErrors=10 — abort batch when reaching the specified number of errors 🛑
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe = no drama, fr fr
  • --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 ✨
  • --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. the "what is HAPPENING" mode 🔍
  • --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. bold move, but ok
  • -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 🔥

Add a related managed object as a child to an existing managed object

look at that. 12345 adopts 6789, relationship type addition. found family, honestly 😭🫶

👑 SEE ALSO 👑

c8y-devices-children(1) — go read the parent page, it's giving lore

💀 real talk: --maxJobs=0 means unlimited and the manpage literally says "use with caution!" — that's not me being dramatic, that's the docs. respect the caution.

okay that's the whole page, you're officially educated 💅✨ this is the c8y(1) manual, dated Jan 1980 (yes really, iconic vintage behavior 🎀), source/version c8y(1) — slay, bye bestie 🦋💖

📦 where this page comes from