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 manual page for c8y — like, section <pink>1</pink> of the manuals, commands-and-all. we're gonna walk through it together, no gatekeeping, no cap. ✨

🌸 NAME 🌸

c8y-deviceregistration-register — literally the command that registers a device using username/password plus manual device approval/bootstrapping. that's the whole vibe. 👑

🦋 SYNOPSIS 🦋

c8y deviceregistration register [flags]

✨ DESCRIPTION ✨

so what we're doing here is registering a new device (request) where that device is out here using the manual device bootstrapping process to go grab its own device credentials — and those credentials are, yep, a username/password pair. it's giving "device gets its own little ID card" energy. 🪪

if you want the ✨lore✨, go read the Cumulocity docs, they have all the details bestie:

https://cumulocity.com/docs/2024/device-integration/rest/

💖 OPTIONS 💖

these are the flags that belong to register itself. one bullet each, no skipping, we're thorough in this house. 🫶

  • -d, --data=[] — static data that gets applied to the body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
  • --group=[] — the group the device is gonna be assigned to
  • -h, --help[=false] — help for register
  • --id=[] — the device identifier. Max: 1000 characters. E.g. IMEI. this one is required and (accepts pipeline) 💀
  • --processingMode="" — Cumulocity processing mode
  • --template="" — body template
  • --templateVars=[] — body template variables
  • --type="" — type of the device
yes, --id is required. do not forget it. i'm not mad, just disappointed. 🙈

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these bad boys come from the parent command, so they're always in the group chat whether you invited them or not. all 55 of them. slay. 💜

  • --abortOnErrors=10 — abort the batch when you hit this specified number of errors
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty
  • --cache[=false] — enable cached responses
  • --cacheBodyPaths=[] — cache should limit hashing to these 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 the 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 a custom message to the activity log
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) 😭
  • --noAccept[=false] — ignore the Accept header, which 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)
  • -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 the 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 ⭐

look at her go, she's literally doing it. 🌟

$ c8y deviceregistration register --id "ASDF098SD1J10912UD92JDLCNCU8"
Register a new device

$ c8y deviceregistration register --id "ASDF098SD1J10912UD92JDLCNCU8" --group "My Group"
Register a new device and assign to a group

🎀 SEE ALSO 🎀

okay that's the whole page bestie, you ate that. 💅 and for the record, this iconic little number is dated Jan 1980 and belongs to c8y(1) — yes, 1980, she's vintage and she's still serving. periodt. 🦋🌸

📦 where this page comes from