c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y(1) — c8y-notification2-subscriptions-create 💖

🌸 NAME 🌸

c8y-notification2-subscriptions-create — create subscription. That’s the whole assignment, bestie. 💅

✨ SYNOPSIS ✨

c8y notification2 subscriptions create [flags]

🦋 DESCRIPTION 🦋

Create a subscription. Literally iconic behavior, no cap. 🎀

👑 OPTIONS 👑

Okay, here’s the full flag lineup. Every single one is here, because we do not skip details in this group chat. 💖

  • --apiFilter=[] — filter notifications by api, bestie.
  • --context="" — the context this subscription is associated with.
  • -d, --data=[] — static data to be applied to body. Accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'.
  • --device=[] — the managed object this subscription is associated with. Accepts pipeline.
  • --fragmentsToCopy=[] — transforms the data to only include specified custom fragments. Each custom fragment is identified by a unique name. If nothing is specified here, the data is forwarded as-is.
  • -h, --help[=false] — help for create. The assist button, fr fr.
  • --name="" — the subscription name. Each subscription is identified by a unique name within a specific context.
  • --nonPersistent[=false] — indicates whether the messages for this subscription are persistent or non-persistent, meaning they can be lost if consumer is not connected. >= 1016.x.
  • --processingMode="" — Cumulocity processing mode.
  • --template="" — body template.
  • --templateVars=[] — body template variables.
  • --typeFilter=[] — the data needs to have the specified value in its type property to meet the filter criteria.

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

These come from the parent commands, and yes, they’re all invited to the party too. 🎉

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

Create a new subscription to operations for a specific device:

$ c8y notification2 subscriptions create --name deviceSub --device 12345 --context mo --apiFilter operations --apiFilter alarms

Create a subscription which groups all devices in a single subscription name:

$ echo -e "1111\n2222" | c8y notification2 subscriptions create --name devicegroup --context mo --apiFilter operations

Create a subscription which groups all devices in a single subscription name, but this time with a pipeline moment:

$ c8y devices list | c8y notification2 subscriptions create --name devicegroup --context mo --apiFilter operations

🌈 SEE ALSO 🌈

c8y-notification2-subscriptions(1)

xoxo, c8y(1) — source/version, dated Jan 1980. 💖🫶✨

📦 where this page comes from