c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌸 NAME 🌸

Okay so bestie, you're looking at the c8y(1) manual page for c8y-deviceregistration-register-ca — Register device with an x509 certificate from the Cumulocity Certificate Authority. Iconic. 💖

✨ SYNOPSIS ✨

c8y deviceregistration register-ca [flags]

🦋 DESCRIPTION 🦋

You're registering a device using the Cumulocity Certificate Authority so the device can request a device certificate securely using EST. This will be supported by thin-edge.io out-of-the-box. 🫶

Heads up: this feature requires the feature toggle, "certificate-authority".

💅 OPTIONS 💅

  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
  • --external-type="c8y_Serial" — The type of the external ID. If IDTYPE doesn't appear in the file, the default value is used. The default value is c8y_Serial
  • --group="" — The path in the groups hierarchy where the device is added. PATH contains the name of each group separated by /, that is: main_group/sub_group/.../last_sub_group. If a group does not exist, the import creates the group
  • -h, --help[=false] — help for register-ca
  • --iccid="" — The ICCID of the device (SIM card number). If the ICCID appears in file, the import adds a fragment c8y_Mobile.iccid.
  • --id=[] — Device identifier. Max: 1000 characters. E.g. IMEI (required) (accepts pipeline)
  • --name="" — Device name. Defaults to the external id
  • --one-time-password="" — One Time Password used for initial enrollment. Leave blank for a randomly generated password
  • --processingMode="" — Cumulocity processing mode
  • --template="" — Body template
  • --templateVars=[] — Body template variables
  • --tenant="" — The ID of the tenant for which the registration is executed (only allowed for the management tenant)
  • --type="thin-edge.io" — Device type

🎀 OPTIONS INHERITED FROM PARENT COMMANDS 🎀

  • --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 🔥

  1. Register a new device using BASIC authentication and generate a random password (printed on the console)
$ c8y deviceregistration register-ca --id "ASDF098SD1J10912UD92JDLCNCU8"
  1. Register a new device and provide the one-time-password to be used for enrollment
$ c8y deviceregistration register-ca --id "ASDF098SD1J10912UD92JDLCNCU8" --one-time-password "RqzwJeTusABlk4)KmtIc"
  1. Register 2 devices, and set the names based on their external id
$ echo -e "device1\ndevice2" | c8y deviceregistration register-ca --type linux --template "{name: input.value}"

🌈 SEE ALSO 🌈

Sign-off: this page is from the c8y(1) manual and is dated Jan 1980 — bye bestie, mwah 💜💅

📦 where this page comes from