c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 NAME 💖

okay so this is the c8y(1) manual page, and the main character here is c8y-devicemanagement — literally Cumulocity Device management, no cap.

✨ SYNOPSIS ✨

c8y devicemanagement [flags]

🦋 DESCRIPTION 🦋

Device Management commands, bestie. That's the vibe: this is where the device-management side of c8y lives. Slay.

🎀 OPTIONS 🎀

  • -h, --help[=false] — shows the help for devicemanagement, i.e. the little built-in cheat sheet. Default is false.

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

these are the inherited flags, aka the parent-command hand-me-downs that still absolutely ate:

  • --abortOnErrors=10 — abort the batch when it reaches the specified number of errors. Default is 10.
  • --allowEmptyPipe[=false] — don't fail when piped input (stdin) is empty. Default is false, so pipe away 🫶
  • --cache[=false] — enable cached responses. Default is false.
  • --cacheBodyPaths=[] — the 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. Default is "60s".
  • -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. Default is false.
  • --confirmText="" — custom confirmation text. Default is "".
  • --currentPage=0 — current page which should be returned. Default is 0.
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'.
  • --debug[=false] — set very verbose log messages. Default is false.
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. Default is "0ms".
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Default is "0ms".
  • --dry[=false] — dry run. Don't send any data to the server. Default is false.
  • --dryFormat="markdown" — dry run output format. i.e. 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 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. Default is false.
  • -f, --force[=false] — do not prompt for confirmation. Ignored when using --confirm. Default is false.
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue".
  • --includeAll[=false] — include all results by iterating through each page. Default is false.
  • -k, --insecure[=false] — allow insecure server connections when using SSL. Default is false.
  • -l, --logMessage="" — add custom message to the activity log. Default is "".
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). Default is 0.
  • --noAccept[=false] — ignore Accept header; this will remove the Accept header from requests, however PUT and POST requests will only see the effect. Default is false.
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). Default is false.
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. Default is false.
  • --noLog[=false] — disables the activity log for the current command. Default is false.
  • --noProgress[=false] — disable progress bars. Default is false.
  • --noProxy[=false] — ignore the proxy settings. Default is false.
  • -n, --nullInput[=false] — don't read the input (stdin). Useful if using in shell for/while loops. Default is false.
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader. Default is "table".
  • --outputFile="" — save JSON output to file (after select/view). Default is "".
  • --outputFileRaw="" — save raw response to file (before select/view). Default is "".
  • --outputTemplate="" — jsonnet template to apply to the output. Default is "".
  • -p, --pageSize=5 — maximum results per page. Default is 5.
  • --progress[=false] — show progress bar. This will also disable any other verbose output. Default is false.
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. Default is "".
  • -r, --raw[=false] — show raw response. This mode will force output=json and view=off. Default is false.
  • --retries=3 — max number of attempts when a failed http call is encountered. Default is 3.
  • --select=[] — comma separated list of properties to return. Wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'.
  • --session="" — session configuration. Default is "".
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. Default is "".
  • -P, --sessionPassword="" — override session password. Default is "".
  • -U, --sessionUsername="" — override session username. i.e. peter or t1234/peter (with tenant). Default is "".
  • --silentExit[=false] — silent status codes do not affect the exit code. Default is false.
  • --silentStatusCodes="" — status codes which will not print out an error message. Default is "".
  • --timeout="600s" — request timeout duration, i.e. 60s, 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 using --view off. Default is "auto".
  • --withError[=false] — errors will be printed on stdout instead of stderr. Default is false.
  • --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Default is false.
  • -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Default is false.
  • --workers=1 — number of workers. Default is 1.

🌈 SEE ALSO 🌈

go check out the rest of the friend group, bestie:

later, bestie — this was the c8y(1) manual page, dated Jan 1980. 🎀💖✨

📦 where this page comes from