c8y(1)

📦 version 2.56.1, in nixpkgs unstable

This is the c8y(1) manual page for c8y inventory findByText — aka c8y-inventory-findByText. Pull up a chair, bestie; we’re finding managed objects by text and it’s about to be iconic. 💅✨

✨ NAME ✨

c8y-inventory-findByText — Find managed object by text collection 💖

🦋 SYNOPSIS 🦋

The summoning line is literally:

c8y inventory findByText [flags]

💅 DESCRIPTION 💅

Find a collection of managedObjects which match a given text value. That’s the whole vibe: you give it text, it hunts for matching managed objects. 🔎🦋

🎀 OPTIONS 🎀

Okay, flag inventory time. Every single one is here, no crumbs left behind:

  • --fragmentType="" — ManagedObject fragment type. 🧩
  • -h, --help[=false] — help for findByText. 🫶
  • --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. 🚫👶
  • --text="" — Search for managed objects where a property value is equal to the given one. The following properties are examined: id, type, name, owner, externalIds. (required) (accepts pipeline) 🚨
  • --type="" — ManagedObject 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 the parent-command flags that come along for the ride. All of them, 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 🌈

Bestie, the examples are literally right here:

$ c8y inventory findByText --text "myText"
Get a list of managed objects

$ echo "myText" | c8y inventory findByText
Find managed objects which contain the text 'myText' (using pipeline)

$ echo "myText" | c8y inventory findByText --fragmentType c8y_IsDevice
Find managed objects which contain the text 'myText' and is a device (using pipeline)

⭐ SEE ALSO ⭐

This page lives in the c8y(1) manual and is dated Jan 1980 — bye bestie, go find those managed objects 💖🫶

📦 where this page comes from