c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y(1) manual page, but make it c8y-microservices-enable 💖

Okay so welcome to the c8y(1) manual page, bestie. Today’s main character is c8y-microservices-enable, and it’s literally here to help you subscribe to a microservice. No cap. 💅

🌸 NAME 🌸

c8y-microservices-enable — subscribe to a microservice. That’s the name, and it’s exactly what it says on the tin. ✨

🦋 SYNOPSIS 🦋

c8y microservices enable [flags]

🎀 DESCRIPTION 🎀

Enabling a microservice — aka subscribing to it — will activate the application in the tenant. So yeah, this is the glow-up switch that makes the app live in your tenant. Periodt. 👑

✨ OPTIONS ✨

  • -d, --data=[] — static data to be applied to the body. Accepts JSON or shorthand JSON, like --data 'value1=1,my.nested.value=100'. 🍓
  • -h, --help[=false] — help for enable.
  • --id="" — microservice id (accepts pipeline).
  • --processingMode="" — Cumulocity processing mode.
  • --template="" — body template.
  • --templateVars=[] — body template variables.
  • --tenant="" — tenant id.

🔁 OPTIONS INHERITED FROM PARENT COMMANDS 🔁

These are inherited from the parent commands, so they’re not unique to enable, but they’re still part of the whole package, bestie. 🫶

  • --abortOnErrors=10 — abort the batch when reaching 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 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, 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 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 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 🌈

$ c8y microservices enable --id 12345
Enable (subscribe) to a microservice

$ c8y microservices enable --id report-agent
Enable (subscribe) to a microservice by name

🧚 SEE ALSO 🧚

xoxo, your c8y(1) manual — Jan 1980 edition 💖

📦 where this page comes from