c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y manual, but make it make sense

okay so bestie, welcome to the c8y page ✨ this is the manual for c8y (section 1 of the man pages, iykyk), and specifically for the c8y-microservices-getBootstrapUser command. yes that's a whole mouthful, no we're not renaming it, it's iconic as-is 🎀

🌸 NAME 🌸

c8y-microservices-getBootstrapUser — get microservice bootstrap user 💖

✨ SYNOPSIS ✨

c8y microservices getBootstrapUser [flags]

like, that's the whole vibe. command, subcommand, sub-subcommand, then flags 🦋

🫶 DESCRIPTION 🫶

So you wanna get the bootstrap user that's associated to a microservice. That's it, that's the job 💅

And why do you care? Because the bootstrap user is literally required when you're running a microservice locally (i.e. during development). No cap — local dev needs that user, so go get it 🔥

👑 OPTIONS 👑

  • -h, --help[=false] — help for getBootstrapUser. defaults to false, obviously 🙈
  • --id="" — the microservice id. this one is required (no skipping it, bestie) and it accepts pipeline input ⭐

🧚 OPTIONS INHERITED FROM PARENT COMMANDS 🧚

these are the family hand-me-downs and honestly they ate 👑

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors. default's 10 💀
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. defaults to false
  • --cache[=false] — enable cached responses ✨ defaults to false
  • --cacheBodyPaths=[] — the 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. default 60s
  • -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. defaults to false
  • --confirmText="" — custom confirmation text, if you want your own words 💬
  • --currentPage=0 — current page which should be returned. default 0
  • --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' 🌈
  • --debug[=false] — set very verbose log messages 🐛 defaults to false
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. default 0ms
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. default 0ms
  • --dry[=false] — dry run. don't send any data to the server 🙈 defaults to false
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl. default markdown
  • --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. be careful with this one, bestie 🫣
  • -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. default table
  • --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. default 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 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. default 600s ⏳
  • --totalPages=0 — total number of pages to get. default 0
  • -v, --verbose[=false] — verbose logging 🗣️
  • --view="auto" — use views when displaying data on the terminal. disable using --view off. default auto
  • --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 1 👯

💜 EXAMPLE 💜

okay here's the part where it gets cute, look at these:

$ c8y microservices getBootstrapUser --id 12345
Get application bootstrap user by app id

so you can grab it by app id — numbers, simple, slay ✨

$ c8y microservices getBootstrapUser --id report-agent
Get application bootstrap user by app name

or by app name — yes bestie, report-agent works too, the id field takes the name, no cap 🎀

🌈 SEE ALSO 🌈

and that's the page!! 💖 fr fr you're now a getBootstrapUser expert. this little gem comes to you from the c8y manual, section 1, dated Jan 1980 (yes, iconic vintage, we don't question it 🕰️). now go get that bootstrap user, bestie 🫶

📦 where this page comes from