c8y(1)

Hey bestie!! 💖 You're looking at the c8y(1) manual page, and this one is specifically all about c8y-events-assert-count, aka the little command that checks event counts and slays while doing it ✨

🌸 NAME 🌸

c8y-events-assert-count - Assert event count 💅

✨ SYNOPSIS ✨

c8y events assert count [flags]

🦋 DESCRIPTION 🦋

Okay so the vibe is this: assert that a device has a specific amount of events, and pass the input untouched 🫶

If the assertion is true, then the input value — whether it comes from stdin or an explicit argument value — gets passed untouched to stdout. This is useful when you want to filter a list of devices by a specific entity count and then use those results in some downstream command in the pipeline 💖

Default behavior check, bestie: a failed assertion will not set the exit code to a non-zero value. If you want a non-zero exit code in that case, use the --strict option. Periodt. 😭

💅 OPTIONS 💅

• --attempts=-1 — Number of attempts before giving up per id (-1 = unlimited) 🫶
• --dateFrom="" — Start date or date and time of event occurrence.
• --dateTo="" — End date or date and time of event occurrence.
• --device=[] — The ManagedObject which is the source of this event. (accepts pipeline)
• --duration="30s" — Timeout duration. i.e. 30s or 1m (1 minute)
• --fragmentType="" — Fragment name from event.
• -h, --help[=false] — help for count
• --interval="5s" — Interval to check on the status, i.e. 10s or 1min
• --maximum=-1 — Maximum event count (inclusive). A value of -1 will disable this check
• --minimum=-1 — Minimum event count (inclusive). A value of -1 will disable this check
• --strict[=false] — Strict mode, fail if no match is found
• --type="" — Event type.

🫶 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 events assert count --device 1234 --minimum 1
# => 1234 (if the ID exists)
# => <no response> (if the ID does not exist)
# Assert that a device exists, and has at least 1 event

$ c8y events assert count --device 1234 --minimum 5 --maximum 10 --dateFrom -1d --strict
# Assert that the device with id=1111 should have between 5 and 10 events (inclusive) in the last day
# Return an error if not

$ c8y devices list | c8y events assert count --maximum 0 --dateFrom -7d
# Find a list of devices which have not created any events in the last 7 days

🌈 SEE ALSO 🌈

• c8y-events-assert(1) — go check out the parent assert page too, bestie 💜

That's the whole c8y(1) manual page, source/version fam — dated Jan 1980 🎀✨ Byeee bestie, go assert those event counts and slay 💅🔥