c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🎀 NAME 🎀

c8y-devices-get — Get device

okay so welcome to the c8y(1) manual, bestie — this page is specifically about c8y-devices-get, and it's giving “fetch me one existing device” energy. 💅✨

🌸 SYNOPSIS 🌸

c8y devices get [flags]

🦋 DESCRIPTION 🦋

Get an existing device. That's the whole vibe: you already have a device, and now you want it back. 👑💖

💖 OPTIONS 💖

  • -h, --help[=false] — help for get. your little “what does this do again?” button 🫶
  • --id=[] — Device ID (required) (accepts pipeline). yes bestie, required — don't skip it 💀
  • --skipChildrenNames[=false] — Don't include the child devices names in the response. This can improve the API response because the names don't need to be retrieved. lowkey a speed-up move ✨
  • --withChildren[=false] — Determines if children with ID and name should be returned when fetching the managed object. Set it to false to improve query performance. performance said “let me breathe” 😭
  • --withChildrenCount[=false] — When set to true, the returned result will contain the total number of children in the respective objects (childAdditions, childAssets and childDevices). counting the little guys fr fr 🧚
  • --withGroups[=false] — When set to true it returns additional information about the groups to which the searched managed object belongs. This results in setting the assetParents property with additional information about the groups. it's giving family tree but make it platform ✨
  • --withLatestValues=false ⟨FEATURE_PREVIEW⟩ — Include c8y_LatestMeasurements fragment, which contains the latest measurement values reported by the device to the platform. feature preview bestie, so treat it with main-character awareness 👀
  • --withParents[=false] — Include a flat list of all parents and grandparents of the given object. ancestry dot com but for your managed object 🌈

💅 OPTIONS INHERITED FROM PARENT COMMANDS 💅

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. safety rails, bestie 🛑
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). empty pipe? not a crisis 🫶
  • --cache[=false] — Enable cached responses. ~memorization~ ✨
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. hashing with boundaries, iykyk 🔥
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m. cache said “I'm not staying forever” 💀
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. terminal gets the pretty version by default, no cap 💅
  • --confirm[=false] — Prompt for confirmation. a tiny “u sure?” moment 🎀
  • --confirmText="" — Custom confirmation text. make the “u sure?” say what you want 🦋
  • --currentPage=0 — Current page which should be returned. page number moment 📄
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. custom query crumbs 🔍
  • --debug[=false] — Set very verbose log messages. lore dump mode 😭
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. cozy little pause after 🔥
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. cozy little pause before 🌸
  • --dry[=false] — Dry run. Don't send any data to the server. rehearsal era 🎭
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl. pick your rehearsal outfit 💖
  • --examples[=false] — Show examples for the current command. show me the moves ✨
  • --filter=[] — Apply a client side filter to response before returning it to the user. client-side filtering, slay 🦋
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested? not anymore bestie 🪄
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. bold choice energy, but --confirm wins 💅
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". header drip 🌈
  • --includeAll[=false] — Include all results by iterating through each page. collect every crumb 🔥
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. ⚠️ insecure bestie, it's literally in the name, proceed with awareness
  • -l, --logMessage="" — Add custom message to the activity log. leave a lil note 🎀
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). unlimited said “be careful” for real 😭
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. specific little header behavior, iykyk 👑
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting). cache off, periodt 💀
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. monochrome moment 🖤
  • --noLog[=false] — Disables the activity log for the current command. no receipts, bestie 🙈
  • --noProgress[=false] — Disable progress bars. no lil bar doing its thing 🫶
  • --noProxy[=false] — Ignore the proxy settings. proxy? never met her 💅
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. loop girlies know 🌸
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader. choose your output aesthetic ✨
  • --outputFile="" — Save JSON output to file (after select/view). save the after version 💾
  • --outputFileRaw="" — Save raw response to file (before select/view). save the before version 🫶
  • --outputTemplate="" — jsonnet template to apply to the output. template time 🎀
  • -p, --pageSize=5 — Maximum results per page. page size said five 🌟
  • --progress[=false] — Show progress bar. This will also disable any other verbose output. progress bar main character moment 📊
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. proxy address goes here 🔌
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. raw and unfiltered, bestie 💀
  • --retries=3 — Max number of attempts when a failed http call is encountered. try again energy, up to three ✨
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. choose your faves 🔥
  • --session="" — Session configuration. session setup vibes 🎀
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled. one-command override, iykyk 👑
  • -P, --sessionPassword="" — Override session password. password override, keep it cute and private 🙈
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). username glow-up 💅
  • --silentExit[=false] — Silent status codes do not affect the exit code. silent but not affecting exit 🫶
  • --silentStatusCodes="" — Status codes which will not print out an error message. quiet codes list 🤫
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. patience has a limit, bestie ⏳
  • --totalPages=0 — Total number of pages to get. how many pages? this many 🦋
  • -v, --verbose[=false] — Verbose logging. tell me everything 🗣️
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. view said auto by default ✨
  • --withError[=false] — Errors will be printed on stdout instead of stderr. error placement tea ☕
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). stats era 🔢
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. more stats, more slay 📚
  • --workers=1 — Number of workers. worker bees count 🐝

🦋 EXAMPLE 🦋

$ c8y devices get --id 12345

Get device by id. simple, iconic, done. 💖

🌈 SEE ALSO 🌈

okay bye bestie — this page's footer energy is date Jan 1980 and source/version stamp c8y(1). historical cutie behavior fr fr 🎀🦋💜

📦 where this page comes from