c8y(1)

okay so bestie, you found the c8y(1) manual page for c8y-sessions-list, aka the little command that gets you a Cumulocity session. It’s giving “pick your session, choose your destiny” energy 💅✨

💖 NAME 💖

c8y-sessions-list — Get a Cumulocity session. That’s the whole vibe: you list sessions, you pick one, you slay. No cap. 🎀

🌸 SYNOPSIS 🌸

c8y sessions list [flags]

🦋 DESCRIPTION 🦋

Get a Cumulocity session. Literally that. That’s the description, bestie — short, sweet, iconic. 💜

💅 OPTIONS 💅

• -h, --help[=false] — help for list. Your little “what does this do again?” button 🫶
• --sessionFilter="" — Filter to be applied to the list of sessions even before the values can be selected. Yes, it filters before the selection part — pre-selection filter realness ✨

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

These are inherited from the parent command, but they still matter, so don’t skip them, iykyk 💜

• --abortOnErrors=10 — Abort batch when reaching specified number of errors. The number here is 10.
• --allowEmptyPipe[=false] — Don’t fail when piped input is empty (stdin). Empty pipe? Not today, bestie 🎀
• --cache[=false] — Enable cached responses.
• --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. Empty [] means 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. Maximum yappage mode 🔥
• --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. The original says it like that; take the warning seriously, bestie. 🚨
• -l, --logMessage="" — Add custom message to the activity log.
• --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). That caution is not decorative, bestie 😭
• --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. The default here is 5.
• --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. Default is 3.
• --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. Default is 1.

🌟 EXAMPLE 🌟

Example 1: Show an interactive list of all available sessions

#> c8y sessions list

Example 2: Select a session and filter the selection of session by the name "customer"

#> export C8Y_SESSION=$( c8y sessions list --sessionFilter "customer" )

🫶 SEE ALSO 🫶

c8y-sessions(1) — go check out the parent-page energy too, bestie 💖

---

later, bestie — this was the c8y(1) manual, dated Jan 1980 🎀🦋💜