c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y(1) — the manual, but make it bestie 💖

Hey bestie! Welcome to the c8y(1) manual page. This is your go-to guide for the c8y command line tool — specifically the deviceregistration list subcommand. It's giving "I'm about to fetch all the device registration requests" energy, and honestly? Obsessed. ✨

🌸 NAME 🌸

c8y-deviceregistration-list — get that device request collection, periodt. 💅

🦋 SYNOPSIS 🦋

c8y deviceregistration list [flags]

🎀 DESCRIPTION 🎀

Okay so this command literally fetches a whole collection of device registration requests. It's like, "gather all the new device requests" — no cap. Super useful when you need to see what's trying to register. 🫶

✨ OPTIONS ✨

  • -h, --help[=false] — shows you this help text, bestie. No cap, it's the most useful flag when you're lost. 💁‍♀️

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

  • --abortOnErrors=10 — abort the whole batch when you hit this many errors. Default is 10. Like, if things go wrong 10 times, it just stops. 💀
  • --allowEmptyPipe[=false] — don't freak out if the piped input (stdin) is empty. It's like, "no input? cool, no problem." Default is false. 🙈
  • --cache[=false] — turn on cached responses. Speeds things up, but might be stale. Default is false. ⚡
  • --cacheBodyPaths=[] — limits which paths in the JSON body get hashed for caching. Empty list means all values. It's a list, so like []. 🧚
  • --cacheTTL="60s" — how long cached stuff lives, as a duration like 60s or 2m. Default is "60s". ⏳
  • -c, --compact[=false] — make JSON output compact instead of pretty-printed. But if you're on a terminal, pretty print is the default anyway. Default is false. 🎀
  • --confirm[=false] — ask before doing the thing. Default is false. 🙋‍♀️
  • --confirmText="" — set your own confirmation message text. Default is empty string "". 💬
  • --currentPage=0 — which page to return. Default is 0. 📄
  • --customQueryParam=[] — add custom URL query params. Example: --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. It's a list. 🔗
  • --debug[=false] — turn on super detailed log messages. Default is false. 🐛
  • --delay="0ms" — wait this long after each request. Like 5ms or 1.2s. Default is "0ms". ⏱️
  • --delayBefore="0ms" — wait this long before each request. Like 5ms or 1.2s. Default is "0ms". ⏳
  • --dry[=false] — dry run mode: don't send any data to the server. Default is false. 🏜️
  • --dryFormat="markdown" — output format for dry runs: json, dump, markdown, or curl. Default is "markdown". 📝
  • --examples[=false] — show examples for the current command. Default is false. 💡
  • --filter=[] — apply a client-side filter to the response before giving it to you. It's a list. 🧹
  • --flatten[=false] — flatten JSON output by replacing nested properties with dot-notation names. Default is false. 🗜️
  • -f, --force[=false] — don't prompt for confirmation. But it's ignored if you're using --confirm. Default is false. 💪
  • -H, --header=[] — add custom headers. Example: --header "Accept: value, AnotherHeader: myvalue". It's a list. 📋
  • --includeAll[=false] — include all results by iterating through every page. Default is false. 🔄
  • -k, --insecure[=false] — allow insecure SSL connections. Not recommended but okay. Default is false. 🔓
  • -l, --logMessage="" — add a custom message to the activity log. Default is empty "". 📝
  • --maxJobs=0 — max number of jobs. 0 means unlimited — use with caution! Default is 0. ⚠️
  • --noAccept[=false] — ignore the Accept header by removing it from requests. But wait — only PUT and POST requests actually see this effect. Default is false. 🚫
  • --noCache[=false] — force disable cached responses. This overwrites the cache setting. Default is false. 🚫
  • -M, --noColor[=false] — don't use colors for log entries on the console. Default is false. 🌈
  • --noLog[=false] — disable the activity log for this command. Default is false. 🚫
  • --noProgress[=false] — turn off progress bars. Default is false. 🚫
  • --noProxy[=false] — ignore proxy settings. Default is false. 🚫
  • -n, --nullInput[=false] — don't read from stdin. Super useful in shell for/while loops. Default is false. 🚫
  • -o, --output="table" — set output format: table, json, csv, csvheader. Default is "table". 📊
  • --outputFile="" — save JSON output to a file, after select/view. Default is empty "". 💾
  • --outputFileRaw="" — save the raw response to a file, before select/view. Default is empty "". 💾
  • --outputTemplate="" — apply a jsonnet template to the output. Default is empty "". 🧩
  • -p, --pageSize=5 — max results per page. Default is 5. 📄
  • --progress[=false] — show a progress bar. This also disables any other verbose output. Default is false. 📊
  • --proxy="" — set a proxy, like http://10.0.0.1:8080. Default is empty "". 🌐
  • -r, --raw[=false] — show the raw response. This forces output=json and view=off. Default is false. 📄
  • --retries=3 — max attempts when an HTTP call fails. Default is 3. 🔁
  • --select=[] — comma-separated list of properties to return. Wildcards and globstar accepted. Example: --select 'id,name,type,**.serialNumber'. It's a list. 🎯
  • --session="" — session configuration. Default is empty "". 🪪
  • --sessionMode="" — override the default session mode for a single command (which would normally be disabled). Default is empty "". 🔧
  • -P, --sessionPassword="" — override the session password. Default is empty "". 🔑
  • -U, --sessionUsername="" — override the session username. Example: peter or t1234/peter (with tenant). Default is empty "". 👤
  • --silentExit[=false] — silent status codes won't affect the exit code. Default is false. 🤐
  • --silentStatusCodes="" — status codes that won't print an error message. Default is empty "". 🤫
  • --timeout="600s" — request timeout duration, like 60s or 2m. Default is "600s". ⏰
  • --totalPages=0 — total number of pages to get. Default is 0. 📚
  • -v, --verbose[=false] — verbose logging. Default is false. 🗣️
  • --view="auto" — use views when displaying data on the terminal. Disable with --view off. Default is "auto". 👀
  • --withError[=false] — print errors to stdout instead of stderr. Default is false. 📤
  • --withTotalElements[=false] — ask Cumulocity to include total elements in response stats under .statistics.totalElements (introduced in 10.13). Default is false. 🔢
  • -t, --withTotalPages[=false] — ask Cumulocity to include total pages in response stats under .statistics.totalPages. Default is false. 📄
  • --workers=1 — number of workers. Default is 1. 👷‍♀️

💜 EXAMPLE 💜

$ c8y deviceregistration list
Get a list of new device requests

Literally just run it and boom — you've got your list of new device requests. Slay. ✨

👑 SEE ALSO 👑

Peace out, bestie! 💖 This manual page is from Jan 1980 and the manual you're reading is c8y(1). Stay slay, and remember: the terminal is your runway. 🫶✨

📦 where this page comes from