c8y(1)

okay so bestie, welcome to the c8y(1) manual page for the Cumulocity CLI — specifically the devices corner of the universe, and it’s lowkey iconic 💅✨

🎀 NAME 🎀

c8y-devices — Cumulocity devices. that’s the name, that’s the vibe, periodt.

✨ SYNOPSIS ✨

c8y devices [flags]

💖 DESCRIPTION 💖

This is the REST endpoint to interact with Cumulocity devices — yes bestie, devices, REST endpoint energy, no cap. 🦋

💅 OPTIONS 💅

• -h, --help[=false] — help for devices; when you need the help text to hold your hand, iconic.

🧬 OPTIONS INHERITED FROM PARENT COMMANDS 🧬

• --abortOnErrors=10 — abort the batch when it reaches the specified number of errors; the option line has 10 right there.
• --allowEmptyPipe[=false] — don’t fail when the piped input (stdin) is empty; empty pipe? not today, bestie.
• --cache[=false] — enable cached responses.
• --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty indicates all values; [] is the whole buffet.
• --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m; syntax shows "60s".
• -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal, so terminal gets the pretty version, periodt.
• --confirm[=false] — prompt for confirmation.
• --confirmText="" — custom confirmation text; put your own words in the "".
• --currentPage=0 — current page which should be returned; 0 is in the option syntax.
• --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'.
• --debug[=false] — set very verbose log messages; debug mode is loud and we love that.
• --delay="0ms" — delay after each request, i.e. 5ms, 1.2s; syntax shows "0ms".
• --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s; syntax shows "0ms".
• --dry[=false] — dry run. don’t send any data to the server. fake it till you make it, but safely.
• --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl; syntax shows "markdown".
• --examples[=false] — show examples for the current command; yes, examples have their own moment.
• --filter=[] — apply a client side filter to response before returning it to the user; [] is the starting point.
• --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested but make it dotted.
• -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. so --confirm wins, no cap.
• -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue".
• --includeAll[=false] — include all results by iterating through each page. all of them. every page. obsessed.
• -k, --insecure[=false] — allow insecure server connections when using SSL. it’s literally in the name, bestie.
• -l, --logMessage="" — add custom message to the activity log; put it in the "".
• --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) — caution is the key word, bestie.
• --noAccept[=false] — ignore Accept header: this will remove the Accept header from requests, however PUT and POST requests will only see the effect. that caveat is important, periodt.
• --noCache[=false] — force disabling of cached responses; it overwrites the cache setting.
• -M, --noColor[=false] — don’t use colors when displaying log entries on the console. monochrome moment.
• --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; syntax shows "table".
• --outputFile="" — save JSON output to file (after select/view); the "" is where the path goes.
• --outputFileRaw="" — save raw response to file (before select/view); the "" is where the path goes.
• --outputTemplate="" — jsonnet template to apply to the output; "" is the blank spot.
• -p, --pageSize=5 — maximum results per page; 5 is in the option syntax.
• --progress[=false] — show progress bar. this will also disable any other verbose output. progress bar says shhh to verbose.
• --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; 3 is in the option syntax.
• --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'.
• --session="" — session configuration; "" is the placeholder.
• --sessionMode="" — override default session mode for a single command which would normally be disabled.
• -P, --sessionPassword="" — override session password; "" is where it goes.
• -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; "" is where the codes go.
• --timeout="600s" — request timeout duration, i.e. 60s, 2m; syntax shows "600s".
• --totalPages=0 — total number of pages to get; 0 is in the option syntax.
• -v, --verbose[=false] — verbose logging; the yapping is the feature.
• --view="auto" — use views when displaying data on the terminal. disable using --view off; syntax shows "auto".
• --withError[=false] — errors will be printed on stdout instead of stderr. plot twist: stdout.
• --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; 1 is in the option syntax.

🦋 SEE ALSO 🦋

go bother these pages next, bestie:

• c8y(1)
• c8y-devices-assert(1)
• c8y-devices-availability(1)
• c8y-devices-children(1)
• c8y-devices-create(1)
• c8y-devices-delete(1)
• c8y-devices-enroll(1)
• c8y-devices-get(1)
• c8y-devices-getSupportedMeasurements(1)
• c8y-devices-getSupportedSeries(1)
• c8y-devices-list(1)
• c8y-devices-services(1)
• c8y-devices-statistics(1)
• c8y-devices-update(1)
• c8y-devices-user(1)

mwah 💋 — signed by the c8y(1) manual crew, source/version c8y(1), date Jan 1980. that’s the whole footer vibe, bye bestie 🫶