c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y(1) — bestie manual page 💖

okay so welcome to the c8y(1) page, and the actual command we're hyping up is c8y-inventory-assert-fragments, aka “Fragments for managed object.” Strap in, bestie — it's giving very specific CLI energy and we're gonna get through every single flag together 🫶

✨ NAME ✨

c8y-inventory-assert-fragments — Fragments for managed object

🌸 SYNOPSIS 🌸

c8y inventory assert fragments [flags]

🦋 DESCRIPTION 🦋

Fragments for an managed object fragment by polling until a condition is met or a timeout is reached.

Like… it keeps polling until the condition hits or the timeout says “bestie, we're done here.” No cap 💅

💅 OPTIONS 💅

  • --attempts=-1 — Number of attempts before giving up per id (-1 = unlimited)
  • --duration="30s" — Timeout duration. i.e. 30s or 1m (1 minute)
  • --fragments=[] — Fragments to fragments for. If multiple values are given, then it will be applied as an OR operation
  • -h, --help[=false] — help for fragments
  • --id=[] — Inventory id (required) (accepts pipeline)
  • --interval="5s" — Interval to check on the status, i.e. 10s or 1min
  • --strict[=false] — Strict mode, fail if no match is found

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

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

$ c8y inventory assert fragments --id 1234 --fragment "c8y_Mobile.iccd"
# Fragments for the managed object to have a non-null c8y_Mobile.iccd fragment

$ c8y inventory assert fragments --id 1234 --fragment '!c8y_Mobile'
# Fragments for the managed object to not have a c8y_Mobile fragment

$ c8y inventory assert fragments --id 1234 --fragment 'name=^\d+-\w+$'
# Fragments for the managed object name fragment to match the regular expression '^\d+-\w+'

$ c8y inventory assert fragments --id 1234 --fragment 'name=^$' --fragment c8y_IsDevice
# Fragments for the managed object name fragment to match the regular expression '^\d+-\w+'

$ c8y inventory assert fragments --id 1234 --duration 1m --interval 10s
# Fragments for the operation to be set to SUCCESSFUL and give up after 1 minute

$ c8y inventory list --device 1111 | c8y operations fragments --status "FAILED" --status "SUCCESSFUL"
# Fragments for operation to be set to either FAILED or SUCCESSFUL

🌈 SEE ALSO 🌈

okay bye bestie! the footer energy on this page is Jan 1980 + c8y(1), so we're closing with vintage-manual realness and a little sparkle ✨🎀💜

📦 where this page comes from