c8y(1)

📦 version 2.56.1, in nixpkgs unstable

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

okay bestie, so this is the c8y manual page (yes, the whole thing is called c8y(1), it's giving main character energy) and specifically we're talking about one little subcommand that you're gonna be obsessed with. let's go 🎀

✨ NAME ✨

c8y-identity-list — get that external identity collection, periodt 💅

🌸 SYNOPSIS 🌸

c8y identity list [flags]

like, that's it. that's the whole vibe. c8y identity list plus whatever flags you wanna throw at it 🦋

💖 DESCRIPTION 💖

so basically: you got a managed object already chillin' in your tenant, and you want the collection of external ids that are related to it. that's the whole job. c8y identity list goes and fetches that little collection for you. no cap, that's it 🫶

🔥 OPTIONS 🔥

here's the stuff you can actually pass to this command, queen:

  • --device=[] — the device id you want, and heads up: it's required (no device, no results, sorry bestie 😭). it also accepts pipeline, so you can pipe stuff in like a boss 💅
  • -h, --help[=false] — shows help for list. your classic "wait what does this do again" button ✨

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the ones you didn't ask for but you got anyway, because your parent command loves you and also because they're genuinely useful. sit down, there's a lot. 💀

  • --abortOnErrors=10 — abort the batch when it hits this many errors. the default is 10, so it taps out at ten oopsies 🛑
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. so your empty pipe doesn't ruin your whole day 🥺
  • --cache[=false] — turn on cached responses. yes, cached. yes, it's faster ⚡
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty means all values get hashed, fyi 🧚
  • --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 the output is the terminal, so this is for when you want it smooshed 📦
  • --confirm[=false] — prompt for confirmation. safety first, babes 🛟
  • --confirmText="" — custom confirmation text, for when you want your prompt to have ✨personality✨
  • --currentPage=0 — current page which should be returned. default 0 📄
  • --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. go off, customize 🎨
  • --debug[=false] — set very verbose log messages. very. verbose. 🔍
  • --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. nothing leaves the house 🙈
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl. default is "markdown" 📝
  • --examples[=false] — show examples for the current command. yes please, show me 🙏
  • --filter=[] — apply a client side filter to the response before returning it to the user. sift it before you see it 🫧
  • --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. bold move, love it 💅
  • -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 last one 🔁
  • -k, --insecure[=false] — allow insecure server connections when using SSL. careful bestie ⚠️
  • -l, --logMessage="" — add a custom message to the activity log 🗒️
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). and yes the caution is in the original, i'm not making that up 💀
  • --noAccept[=false] — ignore Accept header; this 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 the cache setting). cache who? never met her 🙅
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. for the monochrome girlies 🖤
  • --noLog[=false] — disables the activity log for the current command 🔕
  • --noProgress[=false] — disable progress bars. no little spinning thing for you 🌀
  • --noProxy[=false] — ignore the proxy settings. proxy? don't know her 🚪
  • -n, --nullInput[=false] — don't read the input (stdin). useful if you're using it in shell for/while loops 🔄
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader. default is "table" 📊
  • --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. default is 5 📃
  • --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. raw and unfiltered, just how you like it 🔥
  • --retries=3 — max number of attempts when a failed http call is encountered. default 3, so it tries three times before it gives up 😤
  • --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. 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 is "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 👷

🌈 EXAMPLE 🌈

okay this is the part where it gets fun, look:

$ c8y identity list --device 12345
Get a list of external ids for a device

that one gets you a list of external ids for a device. simple. iconic. 🎀

$ c8y devices list | c8y identity list
Get the external ids for each device using pipeline

and this one? pipe c8y devices list into c8y identity list and you get the external ids for each device using pipeline. that's the pipeline fantasy right there, we love a combo move 💖

real talk though: don't forget --device is required on the direct version, so pipeline or --device, pick your fighter 💅

🦋 SEE ALSO 🦋

and that's the whole page, bestie! this beauty comes to you from the c8y(1) manual, dated Jan 1980 (yes, 1980, she's vintage, she's timeless, she's a legend 👑✨). now go list some identities, slay, and remember: every flag you use is a little main character moment 🌸💜

📦 where this page comes from