c8y(1)

📦 version 2.56.1, in nixpkgs unstable

c8y(1) — the bestie edition 💅✨

okay so bestie, welcome to the c8y(1) page. we're doing Notification2 today and we're keeping every single fact. no cap. 🫶

NAME 🎀

c8y-notification2 — Cumulocity Notification2

SYNOPSIS 🦋

the shape of this command is literally:

c8y notification2 [flags]

DESCRIPTION 🌸

it's giving managed tokens and subscriptions for notifications. that's the assignment, periodt. 💅

OPTIONS ⭐

-h, --help[=false] — help for notification2. the cute little helper, obviously.

OPTIONS INHERITED FROM PARENT COMMANDS 👑

okay so these are inherited from the parent commands, and yes there are a lot. but we're not skipping one single option, bestie. every flag is getting its moment. 💖

--abortOnErrors=10 — abort the batch when it reaches the specified number of errors.
--allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty.
--cache[=false] — enable cached responses.
--cacheBodyPaths=[] — the cache should limit hashing to selected paths in the json body; empty means all values.
--cacheTTL="60s" — cache time-to-live (TTL) as a duration, like 60s or 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, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'.
--debug[=false] — set very verbose log messages.
--delay="0ms" — delay after each request, like 5ms or 1.2s.
--delayBefore="0ms" — delay before each request, like 5ms or 1.2s.
--dry[=false] — dry run. don't send any data to the server.
--dryFormat="markdown" — dry run output format, like 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, like --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] — ignoring the Accept header removes 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, like 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, like 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, like --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, like 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, like 60s or 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.