c8y(1)

📦 version 2.56.1, in nixpkgs unstable

Welcome to the c8y(1) manual page, bestie! This one is all about c8y-identity-get, and yes, it’s giving “tiny command, very specific job.” 🎀

🌸 NAME 🌸

c8y-identity-get - Get external identity. That’s the name, no notes. 💅

✨ SYNOPSIS ✨

c8y identity get [flags]

Run it with the flags you need, queen. ✨

💅 DESCRIPTION 💅

Get an external identity object. An external identity will include the reference to a single device managed object. That’s the whole plot — it’s a tiny lookup with main character energy. 👑

🎀 OPTIONS 🎀

  • -h, --help[=false] — help for get, obviously 💅
  • --name="" — External identity name (required) (accepts pipeline)
  • --type="c8y_Serial" — External identity type

🧬 OPTIONS INHERITED FROM PARENT COMMANDS 🧬

  • --abortOnErrors=10 — abort the batch when it reaches the specified number of errors
  • --allowEmptyPipe[=false] — don’t fail when piped input (stdin) is empty
  • --cache[=false] — enable cached responses
  • --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, like 60s or 2m
  • -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
  • --currentPage=0 — current page that should be returned
  • --customQueryParam=[] — add custom URL query parameters, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'
  • --debug[=false] — set very verbose log messages
  • --delay="0ms" — delay after each request, like 5ms or 1.2s
  • --delayBefore="0ms" — delay before each request, like 5ms or 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] — show examples for the current command
  • --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
  • -f, --force[=false] — do not prompt for confirmation; ignored when using --confirm
  • -H, --header=[] — custom headers, like --header "Accept: value, AnotherHeader: myvalue"
  • --includeAll[=false] — include all results by iterating through each page
  • -k, --insecure[=false] — allow insecure server connections when using SSL
  • -l, --logMessage="" — add a custom message to the activity log
  • --maxJobs=0 — maximum number of jobs; 0 = unlimited (use with caution!)
  • --noAccept[=false] — ignore the Accept header; this removes the Accept header from requests, however PUT and POST requests will only see the effect
  • --noCache[=false] — force disabling of cached responses (overwrites the cache setting)
  • -M, --noColor[=false] — don’t use colors when displaying log entries on the console
  • --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
  • -o, --output="table" — output format, like table, json, csv, or 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
  • --proxy="" — proxy setting, like http://10.0.0.1:8080
  • -r, --raw[=false] — show raw response; this mode will force 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="" — override default session mode for a single command which would normally be disabled
  • -P, --sessionPassword="" — override session password
  • -U, --sessionUsername="" — override 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 or 2m
  • --totalPages=0 — total number of pages to get
  • -v, --verbose[=false] — verbose logging
  • --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

🌈 EXAMPLE 🌈

$ c8y identity get --type test --name myserialnumber
Get external identity

That’s the example, bestie — short, sweet, and doing exactly what it says on the tin. 🫶

🦋 SEE ALSO 🦋

c8y-identity(1) — go read the parent command’s page too, iykyk. 🦋

xoxo from the c8y(1) manual, dated Jan 1980 💖

📦 where this page comes from