c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y — the addRoleToGroup glow-up (manual page, c8y(1), bestie edition)

Okay so listen. This is the c8y(1) manual page, and today's main character is c8y-userroles-addRoleToGroup — yes, the whole thing, no skips, no cap. Grab a lil snack 🍓 and let's get into it.

✨ NAME ✨

c8y-userroles-addRoleToGroup — literally just: add a role to a user group. That's the vibe. 💅

🦋 SYNOPSIS 🦋

c8y userroles addRoleToGroup [flags]

🌸 DESCRIPTION 🌸

You know how a user group is just sitting there, existing, being all group-y, and you're like "girl you need a role"? Yeah. This command adds a role to an existing user group. Not a new one, an existing one. Iconic behavior honestly. ✨

🎀 OPTIONS 🎀

  • --group=[] — the Group ID. Required, bestie, no group no party.
  • -h, --help[=false] — show help for addRoleToGroup. Your little safety net. 🫶
  • --processingMode="" — the Cumulocity processing mode. Leave it as-is unless you know what you're doing (iykyk).
  • --role=[] — the user role id. Required, and lowkey it accepts pipeline — so you can pipe that role in like the tech-savvy queen you are. 👑
  • --tenant="" — the Tenant.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

These bad boys aren't even originally from this command — they're inherited from the parents, like good genetics. 😌

  • --abortOnErrors=10 — abort the batch once you hit the specified number of errors.
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. Graceful queen behavior.
  • --cache[=false] — turn on cached responses.
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. Empty means all values get hashed, no exceptions.
  • --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, so it stays cute unless you say otherwise.
  • --confirm[=false] — prompt for confirmation first.
  • --confirmText="" — custom confirmation text, for when you want it to sound like you.
  • --currentPage=0 — the 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. Very. Verbose.
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s.
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Symmetry, we love her.
  • --dry[=false] — dry run. Don't send any data to the server. Fake it till you make it ✨
  • --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 the response before it gets returned to you.
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. Nesting? Flattened. Periodt.
  • -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. All of them. Every last one. 😤
  • -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!! ⚠️ (0 means unlimited and unlimited means chaos, respectfully.)
  • --noAccept[=false] — ignore the Accept header — this removes the Accept header from requests, however PUT and POST requests will only see the effect. Noted. 📝
  • --noCache[=false] — force disabling of cached responses (this overwrites the cache setting).
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. Sad beige logs. 🙈
  • --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. Lifesaver fr fr.
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader.
  • --outputFile="" — save JSON output to file (after select/view).
  • --outputFileRaw="" — save the 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 the progress bar. This will also disable any other verbose output — can't have both, pick a lane 💅
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080.
  • -r, --raw[=false] — show the raw response. This mode will force output=json and view=off. It does NOT negotiate.
  • --retries=3 — max number of attempts when a failed http call is encountered. Persistence queen.
  • --select=[] — comma separated list of properties to return. Wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'.
  • --session="" — session configuration.
  • --sessionMode="" — override the default session mode for a single command, which would normally be disabled.
  • -P, --sessionPassword="" — override the session password.
  • -U, --sessionUsername="" — override the 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. Shhh. 🤫
  • --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. Plot twist.
  • --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 🔥

$ c8y userroles addRoleToGroup --group "12345" --role "*ALARM*"
Add a role to the admin group

Look at her go. Main character energy. 🫶

👑 SEE ALSO 👑

That's the whole page bestie, nothing skipped, nothing hidden. Every flag got her moment. 💖

Mwah 💋 — this page is brought to you by Jan 1980 (yes, that Jan 1980, she's been serving since forever) and the fine folks behind c8y(1). Copyright and license stay exactly where they were. Take care of her, she's iconic. 🎀✨

📦 where this page comes from