c8y(1)

📦 version 2.56.1, in nixpkgs unstable

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

okay so this is the man page for c8y (that's the manual name, section 1, we're being fancy) and specifically the c8y-deviceregistration-approve girlie. she's the one who says "yes bestie, come on in" to new devices. let's get into it 💅

✨ NAME ✨

c8y-deviceregistration-approve — literally just: approve a device request. that's her whole job. icon behavior frankly 👑

🌸 SYNOPSIS 🌸

c8y deviceregistration approve [flags]

🦋 DESCRIPTION 🦋

so you wanna approve a new device request? say less. this command does exactly that 💖

⚠️ the catch, and it's a real one: a device can only be approved if the platform has already received a request for device credentials. no request, no approval. the vibe check has to happen first, no cap.

✨ OPTIONS ✨

  • -d, --data=[] — static data to be applied to the body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' 🍓
  • -h, --help[=false] — help for approve. your lil "what does this do again" button 🫶
  • --id=[] — Device identifier (required) (accepts pipeline). yes, required. do not skip her. ✨
  • --processingMode="" — Cumulocity processing mode
  • --securityToken="" — when accepting a device request, the security token is verified against the token submitted by the device when requesting credentials 🔐
  • --status="" — status of registration
  • --template="" — body template
  • --templateVars=[] — body template variables

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the family traits, handed down from the parent commands. all of them, in order, no skipping 💜

  • --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! — she means it 💀)
  • --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 🌈

approve a new device request, simple as:

$ c8y deviceregistration approve --id "1234010101s01ldk208"
Approve a new device request

and the glow-up version, with a security token in tow 🔥:

$ c8y deviceregistration approve --id "1234010101s01ldk208" --securityToken "abcdef123456"
Approve a new device request and provide a security token

💖 SEE ALSO 💖

and that's the whole page bestie 🎀 this edition of the c8y manual dates allll the way back to Jan 1980 (yes really, she's vintage 💀) and it's the c8y(1) page, section 1, mwah 💋

📦 where this page comes from