c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌸 NAME 🌸

Okay so this is the c8y(1) manual page for c8y-remoteaccess-connect-run, and it is literally “Connect to a device and run a custom command.” bestie, we are connecting and running, periodt. 💅

✨ SYNOPSIS ✨

c8y remoteaccess connect run [flags]

💖 DESCRIPTION 💖

Okay so the whole plot: connect to a device using the local proxy, then run a given command which makes use of the proxy. 🔥

You can run any command you want by providing all arguments after the --, for example:

c8y remoteaccess connect run --device mydevice -- ./run-something.sh %h %p

The local proxy server port and target can be accessed either by using variable references:

  • Target — use %h or the environment variable $TARGET
  • Port — use %p or the environment variable $PORT

It is recommended to use the "%h" (target) "%p" (port) to refer to the local proxy server as this avoid potential problems with variable expansions and removes the need to have to escape variable etc. (e.g. \$HOST). Below shows an example using a custom ssh command:

c8y remoteaccess connect run --device mydevice -- ssh -p %p root@%h

Or you can use a shell to do something more complex and use environment variable references — note the single quotes around the shell command to prevent the variable expansion in your current shell:

c8y remoteaccess connect run --device mydevice -- sh -c 'ssh -p $PORT root@$TARGET'

🎀 OPTIONS 🎀

  • --configuration="" — Remote Access Configuration
  • --device=[] — Device
  • -h, --help[=false] — help for run
  • --listen="127.0.0.1:0" — Listener address. unix:///run/example.sock
  • --multiplex[=false] — Carry all local connections over a single remote access session (yamux), which avoids the setup cost of a new session per connection. Requires a device supporting it (e.g. thin-edge.io), otherwise one session per connection is used. Enabled by default for configurations named with the mux option, e.g. "http+mux:example"

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

Vibe check: these come from the parent commands, but they’re still absolutely yours to use. ✨

  • --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!)
  • --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 🌈

Example one, iconic:

$ c8y remoteaccess connect run --device 12345 -- ssh -p %p root@%h

This starts an interactive SSH session on the device with a given ssh user. 🫶

Example two, the port-forwarding main character moment:

$ c8y remoteaccess connect run --device rpi5-abcdef01 --configuration passthrough -- ssh -p %p -L 1885:127.0.0.1:1883 -o ServerAliveInterval=120 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null root@127.0.0.1

This starts an SSH session to setup port-forwarding to map the remote's 127.0.0.1:1883 port to your machine's 1885 port. 🔥

Example three, web server vibes:

$ c8y remoteaccess connect run --device 12345 --configuration "http:*" --multiplex -- curl -s http://%h:%p/

This runs a command against a web server on the device, carrying all its connections over a single remote access session (if supported by the device). 💅

👑 SEE ALSO 👑

And that’s the whole c8y(1) manual page, bestie — footer says Jan 1980, so go forth and make that local proxy proud. 💖✨

📦 where this page comes from