c8y(1)

📦 version 2.56.1, in nixpkgs unstable

okay so you're on the c8y(1) manual page, bestie — specifically the one for c8y-agents-list, and we're gonna get you all the way together 💖

✨ NAME ✨

c8y-agents-list — get agent collection. That's the whole vibe: it fetches you a collection of agents.

🦋 SYNOPSIS 🦋

c8y agents list [flags]

🌸 DESCRIPTION 🌸

Get a collection of agents based on filter parameters. Lowkey simple, highkey powerful — you pick the filters, it brings back the agent collection.

🎀 OPTIONS 🎀

No skips, no cap — here's the full option menu:

  • --availability="" — filter by c8y_Availability.status
  • --creationTimeDateFrom="" — filter creationTime.date from a specific date
  • --creationTimeDateTo="" — filter creationTime.date to a specific date
  • --fragmentType="" — filter by fragment type
  • --group=[] — filter by group inclusion
  • -h, --help[=false] — help for list
  • --lastMessageDateFrom="" — filter c8y_Availability.lastMessage from a specific date
  • --lastMessageDateTo="" — filter c8y_Availability.lastMessage to a specific date
  • --name="" — filter by name
  • --orderBy="name" — order by. e.g. _id asc or name asc or creationTime.date desc
  • --owner="" — filter by owner
  • --query="" — additional query filter (accepts pipeline)
  • --queryTemplate="" — string template to be used when applying the given query. Use %s to reference the query/pipeline input
  • --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
  • --type="" — filter by type
  • --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)
  • --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.
  • --withLatestValues=false ⟨FEATURE_PREVIEW⟩ — include c8y_LatestMeasurements fragment, which contains the latest measurement values reported by the device to the platform
  • --withParents[=false] — include a flat list of all parents and grandparents of the given object

🧬 OPTIONS INHERITED FROM PARENT COMMANDS 🧬

These are inherited from the parent command, but they're still absolutely yours to use, bestie:

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

Okay these examples are giving exactly what they need to give:

$ c8y agents list --name "sensor*" --type myType

Get a collection of agents with type "myType", and their names start with "sensor".

$ echo "name eq 'sensor*'" | c8y agents list

Get a collection of agents with names starting with "sensor" using a piped inventory query (or could be piped from a file).

$ c8y agents list --creationTimeDateFrom -7d

Get agents which where registered longer than 7 days ago.

$ c8y agents list --creationTimeDateTo -1d

Get agents which where registered in the last day.

$ c8y agents list --name "my example agent" --select type --output csv | c8y agents list --queryTemplate "type eq '%s'"

Find an agent by name, then find other agents which the same type.

🌈 SEE ALSO 🌈

that's the whole c8y(1) page, bestie — Jan 1980 edition, mwah 💖

📦 where this page comes from