c8y(1)

📦 version 2.56.1, in nixpkgs unstable

NAME 🎀

okay so this is the c8y(1) manual page for c8y-retentionrules-get — Get retention rule. yes bestie, that's the whole assignment, and it's giving single-purpose icon energy. ✨

SYNOPSIS 🦋

c8y retentionrules get [flags]

DESCRIPTION 💅

Get an existing retention by id. lowkey simple: you bring the id, it gets the retention. no cap. 🫶

OPTIONS 🌸

-h, --help[=false] — help for get
--id=[] — Retention rule id (required) (accepts pipeline). you literally cannot skip this one, bestie. 💖

OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the inherited flags, and yes, we are listing every single one. periodt.

--abortOnErrors=10 — aborts the batch when it reaches the specified number of errors
--allowEmptyPipe[=false] — don't fail when piped input is empty (stdin)
--cache[=false] — turns on cached responses
--cacheBodyPaths=[] — tells cache to limit hashing to selected paths in the json body; empty means all values
--cacheTTL="60s" — cache time-to-live (TTL) as a duration, like 60s, 2m
-c, --compact[=false] — compacts instead of pretty-printing when output is json; pretty print is the default if output is the terminal
--confirm[=false] — prompts for confirmation
--confirmText="" — sets custom confirmation text
--currentPage=0 — sets the current page which should be returned
--customQueryParam=[] — adds custom URL query parameters, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
--debug[=false] — sets very verbose log messages
--delay="0ms" — delay after each request, like 5ms, 1.2s
--delayBefore="0ms" — delay before each request, like 5ms, 1.2s
--dry[=false] — dry run: don't send any data to the server
--dryFormat="markdown" — dry run output format, like json, dump, markdown or curl
--examples[=false] — shows examples for the current command
--filter=[] — applies a client-side filter to the response before returning it to the user
--flatten[=false] — flattens json output by replacing nested json properties with properties whose names use dot notation
-f, --force[=false] — does not prompt for confirmation; ignored when using --confirm
-H, --header=[] — custom headers, like --header "Accept: value, AnotherHeader: myvalue"
--includeAll[=false] — includes all results by iterating through each page
-k, --insecure[=false] — allows insecure server connections when using SSL
-l, --logMessage="" — adds a custom message to the activity log
--maxJobs=0 — maximum number of jobs; 0 = unlimited (use with caution!)
--noAccept[=false] — ignoring the Accept header removes the Accept header from requests; however PUT and POST requests will only see the effect
--noCache[=false] — forces cached responses off (overwrites cache setting)
-M, --noColor[=false] — no colors when displaying log entries on the console
--noLog[=false] — disables the activity log for the current command
--noProgress[=false] — disables progress bars
--noProxy[=false] — ignores 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, like table, json, csv, csvheader
--outputFile="" — saves JSON output to file (after select/view)
--outputFileRaw="" — saves raw response to file (before select/view)
--outputTemplate="" — jsonnet template to apply to the output
-p, --pageSize=5 — maximum results per page
--progress[=false] — shows progress bar; this also disables any other verbose output
--proxy="" — proxy setting, like http://10.0.0.1:8080
-r, --raw[=false] — shows raw response; this mode forces output=json and view=off
--retries=3 — max number of attempts when a failed http call is encountered
--select=[] — comma separated list of properties to return; wildcards and globstar accepted, like --select 'id,name,type,**.serialNumber'
--session="" — session configuration
--sessionMode="" — overrides default session mode for a single command that would normally be disabled
-P, --sessionPassword="" — overrides session password
-U, --sessionUsername="" — overrides session username, like 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, like 60s, 2m
--totalPages=0 — total number of pages to get
-v, --verbose[=false] — verbose logging
--view="auto" — uses views when displaying data on the terminal; disable with --view off
--withError[=false] — errors will be printed on stdout instead of stderr
--withTotalElements[=false] — asks Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13)
-t, --withTotalPages[=false] — asks Cumulocity to include the total pages in the response statistics under .statistics.totalPages
--workers=1 — number of workers

EXAMPLE 🍓

run it like this, bestie:

$ c8y retentionrules get --id 12345
Get a retention rule