c8y(1)

📦 version 2.56.1, in nixpkgs unstable

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

okay so real talk — you're looking at the manual page for c8y, section 1, and honestly? it's giving "powerful CLI that doesn't gatekeep." no cap. let's get into it ✨

🎀 NAME 🎀

c8y-remoteaccess-connect — connect to a device

like, that's the whole vibe. you're connecting to a device. that's it. that's the function 🫶

✨ SYNOPSIS ✨

c8y remoteaccess connect [flags]

that's the shape of it, bestie. command, then [flags] — and ooh girl, are there flags 🌸

🦋 DESCRIPTION 🦋

you connect to a device using the protocol defined in an existing configuration. that's the tea ☕ — the protocol isn't something you invent on the fly here, it comes from a config you already set up. lowkey elegant, highkey iconic 👑

💖 OPTIONS 💖

  • -h, --help[=false] — help for connect. your little "wait what does this do again" button 🙈

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

okay so this is the big one — everything below is inherited from the parent commands, and there are so many. we're listing all of them, no skipping, periodt 💅

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors. like, girl, know when to log off 😭
  • --allowEmptyPipe[=false] — don't fail when the piped input is empty (stdin). empty pipe? we move 🌸
  • --cache[=false] — enable cached responses. memory? we stan ✨
  • --cacheBodyPaths=[] — cache should limit hashing to selected paths in the json body. empty indicates all values 💖
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. it expires, like my patience for bad docs 💀
  • -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. make it say what you want ✍️
  • --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's loud and she's valid 🗣️
  • --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. manifesting the request without actually sending it 🧚
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl 📝
  • --examples[=false] — show examples for the current command. yes queen, show me how it's done 👑
  • --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. flatten her, she's nested 💅
  • -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm — read that again, bestie 👀
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue" 📨
  • --includeAll[=false] — include all results by iterating through each page. all of them. every last one 🔥
  • -k, --insecure[=false] — allow insecure server connections when using SSL. careful with this one, okay? it's literally called insecure 😭
  • -l, --logMessage="" — add a custom message to the activity log 🖊️
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) — the exclamation mark is theirs, and honestly? deserved 💀
  • --noAccept[=false] — ignore the Accept header; this 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). overrides, she's decisive 💅
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome era 🖤
  • --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. so niche, so useful 🌀
  • -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 — trade-off, bestie ⚖️
  • --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, just vibes ✨
  • --retries=3 — max number of attempts when a failed http call is encountered. try again, 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 the 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. she said talk more 🗣️
  • --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 👷‍♀️

👀 SEE ALSO 👀

go read these too, they're the friends of this page fr fr:

and that's the whole page, bestie 💖 this one's dated Jan 1980 and lives in the c8y(1) section — vintage date, modern energy, we love to see it 🌟 mwah 🎀

📦 where this page comes from