c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

Okay so welcome to the c8y(1) manual page for c8y-auditrecords-create, bestie. This is the one that makes a whole audit record, and yes, it is giving main-character command energy. πŸ’…

✨ NAME ✨

c8y-auditrecords-create β€” create an audit record. Periodt.

πŸ¦‹ SYNOPSIS πŸ¦‹

c8y auditrecords create [flags]

πŸ’… DESCRIPTION πŸ’…

Create a new audit record for a given action. That’s the vibe: you give it the action details, and it makes the audit record. Slay. ✨

🌸 OPTIONS 🌸

  • --activity="" β€” the activity that was carried out.
  • --application="" β€” the application used to carry out the audited action.
  • -d, --data=[] β€” static data to be applied to body; accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'.
  • -h, --help[=false] β€” help for create.
  • --processingMode="" β€” Cumulocity processing mode.
  • --severity="" β€” the severity of action: critical, major, minor, warning or information.
  • --source="" β€” an optional ManagedObject that the audit record originated from (accepts pipeline).
  • --template="" β€” body template.
  • --templateVars=[] β€” body template variables.
  • --text="" β€” text description of the audit record.
  • --time="" β€” time of the audit record; defaults to current timestamp.
  • --type="" β€” identifies the type of this audit record.
  • --user="" β€” the user responsible for the audited action.

πŸŽ€ OPTIONS INHERITED FROM PARENT COMMANDS πŸŽ€

These are inherited from the parent commands, but you still gotta know them, bestie. πŸ‘‘

  • --abortOnErrors=10 β€” abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] β€” don’t fail when piped input is empty (stdin).
  • --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, i.e. 60s, 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 which should be returned.
  • --customQueryParam=[] β€” add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'.
  • --debug[=false] β€” set very verbose log messages.
  • --delay="0ms" β€” delay after each request, i.e. 5ms, 1.2s.
  • --delayBefore="0ms" β€” delay before each request, i.e. 5ms, 1.2s.
  • --dry[=false] β€” dry run; don’t send any data to the server.
  • --dryFormat="markdown" β€” dry run output format, i.e. json, dump, markdown or curl.
  • --examples[=false] β€” show examples for the current command.
  • --filter=[] β€” apply a client side filter to 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, i.e. --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. Yes, that’s the spicy one β€” be careful. 😭
  • -l, --logMessage="" β€” add custom message to the activity log.
  • --maxJobs=0 β€” maximum number of jobs; 0 = unlimited (use with caution!).
  • --noAccept[=false] β€” ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect.
  • --noCache[=false] β€” force disabling of cached responses (overwrites 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, i.e. table, json, csv, 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, i.e. 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, i.e. --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, i.e. 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, i.e. 60s, 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 auditrecords create --type "Inventory" --time "0s" --text "Managed Object updated: my_Prop: value" --source 12345 --activity "Managed Object updated" --severity "information"

Create an audit record for a custom managed object update. Iconic. 🌈

⭐ SEE ALSO ⭐

c8y-auditrecords(1) β€” go read the parent page too, bestie. 🫢


Signing off from the Jan 1980 edition of the c8y(1) manual β€” mwah πŸ’–πŸ’…

πŸ“¦ where this page comes from