c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸ¦‹ NAME πŸ¦‹

okay so this is the c8y(1) manual page, bestie πŸ’– the star of the show is c8y-ui-plugins-versions-update β€” it replaces tags related to a plugin version. periodt πŸ’…

✨ SYNOPSIS ✨

c8y ui plugins versions update [flags]

that's the whole shape of it 🫢

πŸŽ€ DESCRIPTION πŸŽ€

it replaces the tags of a given plugin version in your tenant. no cap, that's the main character energy of this command 🌈

πŸ’– OPTIONS πŸ’–

here's the command-specific menu, bestie β€” every flag matters:

  • -d, --data=[] β€” static data to be applied to the body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' ✨
  • -h, --help[=false] β€” help for update (defaults to false) 🫢
  • --plugin="" β€” Plugin (accepts pipeline) 🌸
  • --processingMode="" β€” Cumulocity processing mode.
  • --tag=[] β€” Tag assigned to the version. Version tags must be unique across all versions and version fields of plugin versions πŸ”₯
  • --template="" β€” Body template.
  • --templateVars=[] β€” Body template variables.
  • --version="" β€” Version.

πŸ‘‘ OPTIONS INHERITED FROM PARENT COMMANDS πŸ‘‘

these are inherited from the parent commands, so they show up here too β€” yes, all of them, bestie 😭

  • --abortOnErrors=10 β€” Abort batch when reaching specified number of errors. default 10.
  • --allowEmptyPipe[=false] β€” Don't fail when piped input is empty (stdin). default false.
  • --cache[=false] β€” Enable cached responses. default false.
  • --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. 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. default false.
  • --confirm[=false] β€” Prompt for confirmation. default false.
  • --confirmText="" β€” Custom confirmation text.
  • --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. default 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. default false.
  • --dryFormat="markdown" β€” Dry run output format, i.e. json, dump, markdown or curl. default markdown.
  • --examples[=false] β€” Show examples for the current command. default false.
  • --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. default false.
  • -f, --force[=false] β€” Do not prompt for confirmation. Ignored when using --confirm. default false.
  • -H, --header=[] β€” custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue".
  • --includeAll[=false] β€” Include all results by iterating through each page. default false.
  • -k, --insecure[=false] β€” Allow insecure server connections when using SSL. default false.
  • -l, --logMessage="" β€” Add custom message to the activity log.
  • --maxJobs=0 β€” Maximum number of jobs. 0 = unlimited (use with caution!) πŸ’€ default 0.
  • --noAccept[=false] β€” Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. default false.
  • --noCache[=false] β€” Force disabling of cached responses (overwrites cache setting). default false.
  • -M, --noColor[=false] β€” Don't use colors when displaying log entries on the console. default false.
  • --noLog[=false] β€” Disables the activity log for the current command. default false.
  • --noProgress[=false] β€” Disable progress bars. default false.
  • --noProxy[=false] β€” Ignore the proxy settings. default false.
  • -n, --nullInput[=false] β€” Don't read the input (stdin). Useful if using in shell for/while loops. default false.
  • -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. default false.
  • --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. default false.
  • --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. default false.
  • --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. default false.
  • --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. default false.
  • --withTotalElements[=false] β€” Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). default false.
  • -t, --withTotalPages[=false] β€” Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. default false.
  • --workers=1 β€” Number of workers. default 1.

🌈 EXAMPLE 🌈

this is the little demo, bestie:

$ c8y ui plugins versions update --plugin 1234 --version 1.0 --tag tag1,latest

Replace tags assigned to a version of a plugin πŸ’–

🫢 SEE ALSO 🫢

c8y-ui-plugins-versions(1) β€” go give it a read, iykyk 🌸


this page is brought to you by c8y(1), dated Jan 1980 β€” mwah πŸ’‹

πŸ“¦ where this page comes from