c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 c8y(1) — the manual page, bestie 💖

Okay so welcome to the c8y(1) manual page, and more specifically the c8y-auditrecords-get command. This is basically the group chat where you ask for an audit record and the CLI delivers. Let's get into it. 🫶

✨ NAME ✨

c8y-auditrecords-get — get an audit record. That's the whole vibe. 💅

🦋 SYNOPSIS 🦋

c8y auditrecords get [flags]

🌸 DESCRIPTION 🌸

Bestie, this command gets an audit record. Lowkey iconic. You point it at an audit ID and it fetches the record for you. No cap, that's it. ✨

💅 OPTIONS 💅

  • -h, --help[=false] — help for get. Like, the help you need when you're lost. 🙈
  • --id=[] — Audit id. Required, bestie — do not forget it. Also accepts pipeline. 👑

🧬 OPTIONS INHERITED FROM PARENT COMMANDS 🧬

Okay these are the flags you get from the parent commands, and there are a lot. But every single one matters, so let's go. 💖

  • --abortOnErrors=10 — abort the batch when you reach the specified number of errors. Basically a safety net. 🛑
  • --allowEmptyPipe[=false] — don't fail when the piped input is empty (stdin). Empty pipe? No problem. 🫶
  • --cache[=false] — enable cached responses. Cache era. ✨
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. Empty indicates all values. iykyk. 🧚
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. Tick tock. ⏳
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal. So if you're in the terminal, it's already cute. 💅
  • --confirm[=false] — prompt for confirmation. Consent check. ✅
  • --confirmText="" — custom confirmation text. Make it your own. 🎀
  • --currentPage=0 — current page which should be returned. Page check. 📄
  • --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. URL rizz. 🔥
  • --debug[=false] — set very verbose log messages. Debug mode: on. 🐛
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. Patience, bestie. ⏱️
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. Same energy, but before. 🫶
  • --dry[=false] — dry run. Don't send any data to the server. Just vibes. 💀
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl. Choose your fighter. 🌈
  • --examples[=false] — show examples for the current command. Examples are always a slay. ✨
  • --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? Not anymore. 💅
  • -f, --force[=false] — do not prompt for confirmation. Ignored when using --confirm. Bold move. 😭
  • -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue". Header game strong. 💪
  • --includeAll[=false] — include all results by iterating through each page. All of it. 👑
  • -k, --insecure[=false] — allow insecure server connections when using SSL. Be careful with this one, bestie. 🙈
  • -l, --logMessage="" — add custom message to the activity log. Put your name on it. 🎀
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). Unlimited era, but use with caution! 😭
  • --noAccept[=false] — ignore Accept header — this will remove the Accept header from requests. However, PUT and POST requests will only see the effect. Sneaky. 💀
  • --noCache[=false] — force disabling of cached responses (overwrites cache setting). No cache for you. 🚫
  • -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. Quiet mode. 🤫
  • --noProgress[=false] — disable progress bars. No loading bar, just vibes. 🫶
  • --noProxy[=false] — ignore the proxy settings. Proxy? Never heard of her. 💅
  • -n, --nullInput[=false] — don't read the input (stdin). Useful if using in shell for/while loops. Loop-friendly. 🔁
  • -o, --output="table" — output format, i.e. table, json, csv, csvheader. Pick your aesthetic. 🌸
  • --outputFile="" — save JSON output to file (after select/view). Save it for later. 💾
  • --outputFileRaw="" — save raw response to file (before select/view). Raw and unfiltered. 🔥
  • --outputTemplate="" — jsonnet template to apply to the output. Template slay. 🎀
  • -p, --pageSize=5 — maximum results per page. Five is the default, bestie. 🖐️
  • --progress[=false] — show progress bar. This will also disable any other verbose output. Progress but quiet. 📊
  • --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. Proxy era. 🌐
  • -r, --raw[=false] — show raw response. This mode will force output=json and view=off. Raw is law. 💀
  • --retries=3 — max number of attempts when a failed http call is encountered. Three strikes, then we're out. ⚾
  • --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 vibes. 🔐
  • --sessionMode="" — override default session mode for a single command which would normally be disabled. One-time override. 💅
  • -P, --sessionPassword="" — override session password. Password but make it override. 🔑
  • -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. Quiet exit. 🤫
  • --silentStatusCodes="" — status codes which will not print out an error message. No error message for these. 🚫
  • --timeout="600s" — request timeout duration, i.e. 60s, 2m. Ten minutes default. ⏰
  • --totalPages=0 — total number of pages to get. Page count. 📚
  • -v, --verbose[=false] — verbose logging. Tell me everything. 🗣️
  • --view="auto" — use views when displaying data on the terminal. Disable using --view off. Auto is the default. 👀
  • --withError[=false] — errors will be printed on stdout instead of stderr. Error but make it stdout. 😭
  • --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. Page stats. 📊
  • --workers=1 — number of workers. One worker default, bestie. 👷

🎀 EXAMPLE 🎀

$ c8y auditrecords get --id 12345

Get an audit record by id. Literally that simple. Slay. 💅

🦋 SEE ALSO 🦋

Okay that's the whole page! This one comes from the c8y(1) manual, dated Jan 1980 — yes, vintage. Bye bestie! 🫶✨

📦 where this page comes from