c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1)

okay so bestie, welcome to the c8y manual page ✨ this is the one for updating service status, and ngl it's lowkey a lot of flags, but we're gonna get through it together 🫶

🌸 NAME 🌸

c8y-devices-services-update — literally just: Update service status. that's the whole vibe 💅

✨ SYNOPSIS ✨

c8y devices services update [flags]

yep, that's it. command, then flags. iconic, no notes 👑

🎀 DESCRIPTION 🎀

Update service status. you point it at a device's service, you tell it a status, it does the thing. main character energy fr 💖

💖 OPTIONS 💖

here's the full list, no skipping, we don't do that here 🍓

  • -d, --data=[] — static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100' ✨
  • --device=[] — Device id (required for name lookup) 🦋
  • -h, --help[=false] — help for update. the classic.
  • --id=[] — Service id (required) (accepts pipeline). yeah bestie it's required, don't forget it 😭
  • --name="" — Service name 🌸
  • --processingMode="" — Cumulocity processing mode
  • --serviceType="" — Service type, e.g. systemd
  • --status="" — Service status
  • --template="" — Body template
  • --templateVars=[] — Body template variables

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the ones you get from the parent command, like inherited trauma but useful 🎀 — we're listing all of them, periodt:

  • --abortOnErrors=10 — Abort batch when reaching 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, 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
  • --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
  • --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
  • --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 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
  • -l, --logMessage="" — Add custom message to the activity log
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!) ⚠️ like fr, 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
  • --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 🦋

okay bestie, here's how you actually use it 👇

$ c8y devices services update --id 12345 --status up
Update service status

and here's the iconic pipeline version, where you pipe in a service from list and update straight off that (ate, no crumbs) 💅

$ c8y devices services list --device 12345 --name ntp | c8y devices services update --status up
Update service status

👑 SEE ALSO 👑

ngl bestie, that's the whole page. every flag accounted for, nothing skipped. slay 🌟

kisses and good vibes, this page was brought to you by the Jan 1980 crew 💖 and yeah, it's still c8y(1) — catch you in the next manpage, mwah 🎀✨

📦 where this page comes from