c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y-devices-services-find, like, the manual for c8y(1)

okay so bestie, welcome to the c8y(1) man page corner of the internet 🫶 this one's all about c8y-devices-services-find, and it's genuinely so useful. no cap.

✨ NAME ✨

c8y-devices-services-find — find services 💖 (yes, that's the whole name, it's a long one, we don't make the rules)

🌸 SYNOPSIS 🌸

c8y devices services find [flags]

literally just that. command, subcommand, sub-subcommand, then your flags. easy. ✨

🦋 DESCRIPTION 🦋

Find services of any device. that's the vibe. you point it at a device, it goes looking for the services chilling on it. lowkey iconic. 👑

🎀 OPTIONS 🎀

  • -h, --help[=false] — help for find. when you're lost, this is your bestie. 😭
  • --name="" — filter by name. you want a specific service? name it, babes.
  • --orderBy="" — order by, e.g. _id asc or name asc or creationTime.date desc. sort it however you like, main character energy only. ✨
  • --query="" — additional query filter. extra filtering on top, iykyk.
  • --serviceType="" — filter by service type, e.g. systemd. so you can be like "only systemd ones pls" 💅
  • --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. tl;dr: faster response, no child names. slay. 🔥
  • --status="" — filter by service status (custom values allowed). yes, custom values too, it's giving flexible. 🌈
  • --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. so like, true = more info, false = faster. your call, babe. 🫶
  • --withChildrenCount[=false] — when set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices). counting the children, literally. 🧚
  • --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. group chat info, essentially. 💬
  • --withParents[=false] — include a flat list of all parents and grandparents of the given object. the whole family tree, no cap. 🌳

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these ones come from the parent, so you get them for free everywhere. iconic inheritance behaviour, honestly. 💜

  • --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
💀 quick heads up bestie: --maxJobs=0 means unlimited, and the original literally says "(use with caution!)" so like… caution, okay? don't come for me.

⭐ EXAMPLE ⭐

okay these are the ones you'll actually use, look:

$ c8y devices services find
Find all services (from any device)

find all services, from any device. the full sweep. 💅

$ c8y devices services find --status down
Find any services which are currently down

sad services only 😭 perfect for when something's broken and you need to know what.

$ c8y devices services find --name ntp --status down
Find any ntp services which are currently down

the ntp ones specifically AND down. combo filter, ate. 🔥

🌈 SEE ALSO 🌈

and that's the whole page, bestie! this one's from the c8y(1) manual, dated Jan 1980 (yes, literally, the footer says Jan 1980, we love a vintage moment 🎀). mwah, go find some services 💖✨

📦 where this page comes from