c8y(1)

🦋 c8y-agents-get — Get agent (from the c8y(1) manual) 🦋

🌸 NAME 🌸

c8y-agents-get — Get agent. That’s the whole vibe, bestie. 💅

✨ SYNOPSIS ✨

c8y agents get [flags]

💖 DESCRIPTION 💖

Get an agent's managed object representation. No cap, that’s what this command is here for — it pulls up the managed object version of an agent for you. 🫶

🎀 OPTIONS 🎀

• -h, --help[=false] — help for get. The classic “wait, what does this do again?” button. 🙈
• --id=[] — Agent ID (required) (accepts pipeline). Yes, it’s required, so don’t forget it — and it can take piped input too. 🔥
• --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. Basically: skip the name lookup, let the API breathe. ✨
• --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 “thank you” in advance. ⭐
• --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, iconic. 👑
• --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. Group chat energy, but for managed objects. 💜
• --withLatestValues=false ⟨FEATURE_PREVIEW⟩ — Include c8y_LatestMeasurements fragment, which contains the latest measurement values reported by the device to the platform. Feature-preview behavior, so peek responsibly. 🌈
• --withParents[=false] — Include a flat list of all parents and grandparents of the given object. Family tree reveal, but flat. 🌸

🧬 OPTIONS INHERITED FROM PARENT COMMANDS 🧬

• --abortOnErrors=10 — Abort batch when reaching specified number of errors. Ten strikes and the batch is out. 💀
• --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). Empty pipe? Not today, bestie. 🫶
• --cache[=false] — Enable cached responses. Snappy and lowkey efficient. ✨
• --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. Cute little expiration timer. ⏳
• -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. Compact mode is giving “minimalist queen.” 💅
• --confirm[=false] — Prompt for confirmation. A little “are you sure?” moment. 🥺
• --confirmText="" — Custom confirmation text. Make the “are you sure?” sound like you. 💖
• --currentPage=0 — Current page which should be returned. Page zero, the opener. 📖
• --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Custom query chaos, but organized. 🔥
• --debug[=false] — Set very verbose log messages. Turn the volume all the way up. 🔊
• --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. A tiny pause between moves. 🦋
• --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Stretch first, then request. 🌸
• --dry[=false] — Dry run. Don't send any data to the server. Rehearsal mode, no cap. 🎭
• --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. Bestie behavior: show, don’t just tell. ✨
• --filter=[] — Apply a client side filter to response before returning it to the user. Filter it before it hits your feed. 🧚
• --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. Nested but make it flat. 🫶
• -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm. Bold, but read the fine print. 💅
• -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". Headers with main character energy. 👑
• --includeAll[=false] — Include all results by iterating through each page. All the pages, all the results, full commitment. 🔥
• -k, --insecure[=false] — Allow insecure server connections when using SSL. This is the risky little shortcut — be careful, bestie. 😭
• -l, --logMessage="" — Add custom message to the activity log. Leave your mark. 💌
• --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). Unlimited jobs is powerful and a little unhinged. 💀
• --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. Weird but true, iykyk. 🫠
• --noCache[=false] — Force disabling of cached responses (overwrites cache setting). Cache? Never heard of her. 🙈
• -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. Log off, literally. ✌️
• --noProgress[=false] — Disable progress bars. No little bar, just vibes. 🌈
• --noProxy[=false] — Ignore the proxy settings. Proxy who? 💅
• -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops. Loops said “please don’t block.” 🌀
• -o, --output="table" — Output format i.e. table, json, csv, csvheader. Pick your aesthetic. 🎀
• --outputFile="" — Save JSON output to file (after select/view). The post-glow keepsake. 💾
• --outputFileRaw="" — Save raw response to file (before select/view). The unfiltered director’s cut. 🎬
• --outputTemplate="" — jsonnet template to apply to the output. Template it, slay it. ✨
• -p, --pageSize=5 — Maximum results per page. Five at a time, cute and manageable. 🍓
• --progress[=false] — Show progress bar. This will also disable any other verbose output. Progress bar enters, verbose output leaves. 🚪
• --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. Route it through the proxy. 🌉
• -r, --raw[=false] — Show raw response. This mode will force output=json and view=off. Raw and unfiltered, periodt. 🔥
• --retries=3 — Max number of attempts when a failed http call is encountered. Three tries, then we assess. 😤
• --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, very demure. 🎀
• --sessionMode="" — Override default session mode for a single command which would normally be disabled. One-command override, iconic. 👑
• -P, --sessionPassword="" — Override session password. Secret secret. 🤫
• -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant). Name tag, but make it auth. 🏷️
• --silentExit[=false] — Silent status codes do not affect the exit code. Quiet exit, loud boundaries. 💅
• --silentStatusCodes="" — Status codes which will not print out an error message. Some codes get the silent treatment. 🙊
• --timeout="600s" — Request timeout duration, i.e. 60s, 2m. Ten minutes max, bestie. ⏰
• --totalPages=0 — Total number of pages to get. Page count destination. 🗺️
• -v, --verbose[=false] — Verbose logging. Tell me everything. 👀
• --view="auto" — Use views when displaying data on the terminal. Disable using --view off. Auto view is the default vibe. 🦋
• --withError[=false] — Errors will be printed on stdout instead of stderr. Error messages switching lanes. 🚗
• --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Stats with receipts. 🧾
• -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Page-count lore. 📚
• --workers=1 — Number of workers. One worker, one dream. 💪

💫 EXAMPLE 💫

$ c8y agents get --id 12345
Get agent by id

That’s the whole little demo: fetch the agent by ID and get “Get agent by id.” Short, sweet, slay. ✨

👀 SEE ALSO 👀

• c8y-agents(1) — the parent-command bestie you should also check out. 🫶

xoxo, your c8y(1) manual bestie — Jan 1980 edition 🎀💖