c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — c8y-notification2-subscriptions-list 💅

🎀 NAME 🎀

c8y-notification2-subscriptions-list — get the subscription collection. That’s the whole main-character assignment, bestie. ✨

🦋 SYNOPSIS 🦋

c8y notification2 subscriptions list [flags]

🌸 DESCRIPTION 🌸

okay so this command retrieves all subscriptions on your tenant, or a specific subset based on queries. It’s giving “filtered subscription collection realness,” and it’s literally useful. 🫶

✨ OPTIONS ✨

these are the list-specific options, bestie — no cap, take them exactly as written. 💅

  • --context="" — the context the subscription is associated with. 🎀
  • --device=[] — the managed object ID the subscription is associated with. It accepts pipeline input. 🫶
  • -h, --help[=false] — show help for list. ✨
  • --subscription="" — the subscription name that filtering will use. >= 1016.x. 🌸
  • --typeFilter="" — the type used to filter subscriptions; this checks the subscription’s subscriptionFilter.typeFilter field. >= 1016.x. 🔥

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

not me showing you the parent-command options too — but they’re inherited and they all matter, iykyk. 🫶

  • --abortOnErrors=10 — abort the batch when it reaches the 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, like 60s or 2m. ⏳
  • -c, --compact[=false] — compact output 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 — the 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 the 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 a custom message to the activity log. 🪵
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). ⚠️
  • --noAccept[=false] — ignore the Accept header; this removes the Accept header from requests, however PUT and POST requests will only see the effect. 🚫
  • --noCache[=false] — force disabling of cached responses (overwrites the 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. 👷

🍓 EXAMPLE 🍓

these examples are literally the vibe check, bestie. run them exactly like this. 🍓

$ c8y notification2 subscriptions list
Get existing subscriptions

$ c8y notification2 subscriptions list --context mo
Get all subscriptions for the managed object scope

$ c8y notification2 subscriptions list --device 12345
Get all subscriptions related to a specific source

🔗 SEE ALSO 🔗

🫶 that’s the whole glow-up, bestie — source/version c8y(1), date Jan 1980. periodt. 💅
📦 where this page comes from