c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y deviceregistration getCredentials glow-up

okay bestie, so this is a page from the c8y manual (yes, the c8y manual, section 1, we're fancy) — and it's literally all about grabbing device credentials. sit down, hydrate, let's go 🫶

✨ NAME ✨

c8y-deviceregistration-getCredentials — request device credentials, periodt. 💫

🎀 SYNOPSIS 🎀

c8y deviceregistration getCredentials [flags]

that's the whole vibe. command, subcommand, sub-subcommand, then whatever flags you feel like sprinkling on top ✨

🦋 DESCRIPTION 🦋

okay so picture this: a device shows up to the tenant with no credentials at all — like, it literally cannot get in. and that's the whole point, bestie. devices that don't have credentials for accessing a tenant yet can ask for them through this API. 🌸

the way that works is: since the device has no credentials yet, a set of fixed credentials is used for this API. you get those credentials by contacting support. no cap.

🚨 do NOT use your tenant credentials with this API. like, seriously. that's not the move. keep your tenant creds out of this entirely, iykyk. 💀

💖 OPTIONS 💖

okay this is the main character section, let's go one by one 📋

  • -d, --data=[] — static data to be applied to body. it accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' ✨
  • -h, --help[=false] — help for getCredentials. the classic. 🙈
  • --id=[] — device identifier. Max: 1000 characters. E.g. IMEI. this one is (required) and it (accepts pipeline) — so pipe it in if that's your thing 🫶
  • --processingMode="" — Cumulocity processing mode 👑
  • --template="" — body template 🎀
  • --templateVars=[] — body template variables 🧚

🔥 OPTIONS INHERITED FROM PARENT COMMANDS 🔥

these are the flags that come from the parent commands — the family heirlooms, the hand-me-downs, and honestly? iconic. 💜

  • --abortOnErrors=10 — abort batch when reaching specified number of errors 🛑
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin) 🫧
  • --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 🐛
  • --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 🌈

here's the demo, bestie — request credentials for a brand new device, look at her go 💅

$ c8y deviceregistration getCredentials --id "device-AD76-matrixer"
Request credentials for a new device

👑 SEE ALSO 👑

okay that's the whole page!! 💖 this one's from the c8y manual, dated Jan 1980 (yes, literally, that's the date on it, we don't question the timeline, we just vibe with it 🕰️✨). now go get those credentials, but remember — support gives you the fixed credentials, not your tenant ones. mwah 🎀💜

📦 where this page comes from