c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌸 NAME 🌸

okay so hi bestie, welcome to the c8y(1) manual page — yes, the manual itself — and this specific page is for c8y-sessions-set 💅. Its whole job? Set Cumulocity session. That's the summary, no cap.

✨ SYNOPSIS ✨

c8y sessions set [flags]

[flags] is just the little buffet of options down below, bestie 🍓.

🦋 DESCRIPTION 🦋

Set a session, log in, test the session, and get either an OAuth2 token, or do the two-factor authentication thing. That's literally the whole arc 😭✨.

🎀 OPTIONS 🎀

  • --browserCallback="" — Custom redirect URI for the browser flow's local callback server, e.g. http://127.0.0.1:8080/callback. It must match a URI registered in the SSO provider. If you don't pass one, it defaults to http://127.0.0.1:5001/callback. cute.
  • --clear[=false] — Clear any existing tokens. byeee 👋
  • -h, --help[=false] — help for set. the classic.
  • --loginType="" — Login type preference, e.g. OAUTH2_INTERNAL, DEVICE (device flow), BROWSER (Authorization Code via browser), BASIC or CERTIFICATE (mTLS). OAUTH2 is a legacy alias for DEVICE. When set to BASIC, any existing token will be cleared. so many vibes, pick one.
  • --no-banner[=false] — Don't show the session banner. no intro, straight to the content 🎬
  • --sessionFilter="" — Filter to be applied to the list of sessions even before the values can be selected. it's giving pre-game filter.
  • --shell="" — Shell type to return the environment variables. tell it your shell lore.
  • --tfaCode="" — Two Factor Authentication code. the little six-digit bestie 🔐

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the parent-command options that come along for the ride, bestie 🫶

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. okay stop, we've had enough 💀
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). empty pipe? still valid.
  • --cache[=false] — Enable cached responses. reuse the good stuff.
  • --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. are you sure, bestie?
  • --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. lore dump 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. window shopping.
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl.
  • --examples[=false] — Show examples for the current command. yes bestie, show me the moves.
  • --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. you already know what that means.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). the caution is real.
  • --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 🔥

  • 🧚 Interactive session setup
$ eval $( c8y sessions set )

Set a session interactively.

  • 🫶 Filter the session list first
$ eval $( c8y sessions set --sessionFilter "company dev" )

Set a session but only include session matching company AND dev.

  • 🔐 Use a file and a TFA code
$ eval $( c8y sessions set --session myfile.json --tfaCode 123456 )

Set a session using a given file (non-interactively).

  • 📱 Device flow moment
$ eval $( c8y sessions set --session myfile.json --loginType DEVICE )

Login using the OAuth2 device flow (polls for approval after visiting the URL shown in the terminal).

  • 🌐 Browser flow moment
$ eval $( c8y sessions set --session myfile.json --loginType BROWSER )

Login using Authorization Code flow – opens the system browser and waits for the callback.

  • 🎀 Browser flow but custom callback
$ eval $( c8y sessions set --session myfile.json --loginType BROWSER --browserCallback http://127.0.0.1:8080/callback )

Login via browser with a custom callback URL registered in the SSO provider.

  • 🪪 Certificate era
$ eval $( c8y sessions set --session myfile.json --loginType CERTIFICATE )

Login using a device certificate (mTLS); reads cert paths from the session file or C8Y_CERTIFICATE / C8Y_CERTIFICATE_KEY env vars.

👑 SEE ALSO 👑

c8y-sessions(1)

xoxo, c8y(1) — Jan 1980 edition 🎀💖

📦 where this page comes from