c8y(1)

📦 version 2.56.1, in nixpkgs unstable

👑 c8y — the manual (fr fr)

okay bestie, so literally the first thing you need to know is that this is the c8y command-line tool's manual page. that's the main character energy right there. periodt.

✨ NAME ✨

c8y-deviceprofiles-list — get the whole device profile collection, no cap

🦋 SYNOPSIS 🦋

c8y deviceprofiles list [flags]

💅 DESCRIPTION 💅

so basically this command gets you a whole collection of device profiles (they're managedObjects btw, iykyk) based on whatever filter parameters you throw at it. it's giving "show me what you've got" energy. 💖

🔥 OPTIONS 🔥

okay so there are flags. a lot of flags. don't panic, we're getting through all of them together 🫶

  • -h, --help[=false] — shows you the help for list. iconic, honestly.
  • --name="" — filter by name. yes it accepts a pipeline, slay.
  • --orderBy="creationTime.date desc,creationTime desc" — orders your results. for example you could do _id asc or name asc or creationTime.date desc. choose your own adventure. ✨
  • --query="" — additional query filter. extra filtering? we love to see it.
  • --queryTemplate="" — string template that gets used when applying the given query. use %s to reference the query/pipeline input. it's giving plug-and-play.
  • --skipChildrenNames[=false] — don't include the child devices' names in the response. this can improve the API response because the names don't need to be retrieved. lowkey a performance glow-up.
  • --withChildren[=false] — determines if children with ID and name should be returned when fetching the managed object. set it to false to improve query performance.
  • --withChildrenCount[=false] — when set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices). count them all, bestie.
  • --withGroups[=false] — when set to true it returns additional information about the groups to which the searched managed object belongs. this results in setting the assetParents property with additional information about the groups.
  • --withParents[=false] — include a flat list of all parents and grandparents of the given object. family tree time 🌈

🌸 OPTIONS INHERITED FROM PARENT COMMANDS 🌸

these are the flags that come from the parent command. they're basically the hand-me-downs but make it fashion. still iconic, still important:

  • --abortOnErrors=10 — abort the batch when reaching the specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe? no drama.
  • --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. for when you need to know EVERYTHING.
  • --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. literally just vibes.
  • --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!). not me telling you to be careful but also… be careful.
  • --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. five is the default, bestie.
  • --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'. choosey.
  • --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 🎀

here's the vibe in action:

$ c8y deviceprofiles list
Get a list of device profiles

literally that simple. you ask, it gets. 💖

💜 SEE ALSO 💜

okay and that's the whole manual! the source/version and date at the bottom said Jan 1980 and it's the c8y(1) page, so shoutout to the og docs for the lore. you're gonna do amazing with this, i'm literally so proud of you already 🫶✨💅

📦 where this page comes from