c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y command, bestie edition

okay so real talk, this is the manual page for c8y (that's the name up top, and yes she's iconic). it's a whole CLI and this particular page is about one specific little corner of it. buckle up 🎀

✨ NAME ✨

c8y-remoteaccess-configurations-get — get a remote access configuration. that's the whole vibe. one job, does it slay.

🌸 SYNOPSIS 🌸

c8y remoteaccess configurations get [flags]

like, that's it. that's the incantation. flags are optional but they're also kind of the whole personality, so 👀

🦋 DESCRIPTION 🦋

get an existing remote access configuration for a device. literally just fetch it. it's giving "lowkey errand, highkey useful" 💖

🔥 OPTIONS 🔥

these are her options, the ones that belong to get specifically:

  • --device=[] — the device. which one? yours. put it here 🫶
  • -h, --help[=false] — help for get. the classic "what does anything mean" button.
  • --id=[] — the connection. and ngl this one accepts pipeline — so you can pipe stuff in 😭

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

these are the family traits, passed down from the parent commands. there are a lot of them. hydration check, bestie, get a drink 🍓

  • --abortOnErrors=10 — abort the batch when you hit this specified number of errors. ten strikes and she's out.
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. empty pipe? no drama.
  • --cache[=false] — enable cached responses. memory of a goldfish but make it intentional.
  • --cacheBodyPaths=[] — cache should limit hashing to selected paths in the json body. empty means all the values. everything. the whole buffet.
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. how long before it forgets.
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal. (terminal = main character, gets the pretty version.)
  • --confirm[=false] — prompt for confirmation. are you sure, bestie?
  • --confirmText="" — custom confirmation text. write your own "r u sure tho".
  • --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. she will NOT stop talking.
  • --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. window shopping only 🛍️
  • --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. ✨curated✨
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. un-nest her. let her breathe.
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. (so --confirm wins the argument, as she should.)
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — include all results by iterating through each page. no crumbs left behind.
  • -k, --insecure[=false] — allow insecure server connections when using SSL. ⚠️ risky behavior, proceed with your whole chest and your eyes open.
  • -l, --logMessage="" — add custom message to the activity log. leave a little note in the group chat.
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). the manpage itself is giving you the side-eye here, so take the hint 💀
  • --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). she overrules.
  • -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. no lil moving bar, just vibes.
  • --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. bar takes the mic 🎤
  • --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. no filter, no makeup, raw.
  • --retries=3 — max number of attempts when a failed http call is encountered. three tries. she believes in you.
  • --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. 🔐 keep her secret.
  • -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. after this, she's leaving the chat.
  • --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. one. but you could have more 👀

🌈 EXAMPLE 🌈

here's the moment you've all been waiting for, the demo:

$ c8y remoteaccess configurations get --device device01 --id 1
Get existing remote access configuration

look at her go. effortless. ate and left no crumbs 🔥

👑 SEE ALSO 👑

reminder bestie: --insecure and --maxJobs=0 are the two that the manpage itself flags as spicy. the spice is real. respect the spice 🌶️

kisses and clean exit codes 💅 — this has been c8y(1), dated Jan 1980 (yes, she's vintage, she's a classic, she's timeless 🎀). periodt. ✨

📦 where this page comes from