c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸ’… c8y(1) β€” the c8y manual, bestie edition ✨

okay so welcome to the c8y manual page, bestie 🫢 this is the c8y(1) page and we're gonna walk through it together, no cap. buckle up, it's giving very thorough, very iconic.


🌸 NAME 🌸

c8y-bulkoperations-list β€” lowkey get the bulk operation collection. that's the whole vibe. πŸ’–


✨ SYNOPSIS ✨

c8y bulkoperations list [flags]

πŸ¦‹ DESCRIPTION πŸ¦‹

Get a collection of bulk operations. yes bestie, that's literally it β€” you're fetching the whole lineup of bulk operations. slay. πŸ’…


πŸŽ€ OPTIONS πŸŽ€

  • --dateFrom="" β€” start date, or start date and time, of the bulk operation. filter the vibes by when they started πŸ•°οΈ
  • --dateTo="" β€” end date, or end date and time, of the bulk operation. the other end of the timeline πŸ’«
  • -h, --help[=false] β€” help for list. your little safety net, always there 🫢
  • --status=[] β€” operation status, and it can be one of SUCCESSFUL, FAILED, EXECUTING or PENDING. those four, periodt ⭐
  • --withDeleted[=false] β€” include CANCELLED bulk operations. the deleted girlies get to come to the party too πŸ™ˆ

πŸ‘‘ OPTIONS INHERITED FROM PARENT COMMANDS πŸ‘‘

these are the hand-me-downs from the parent command and honestly they ate πŸ’…

  • --abortOnErrors=10 β€” abort the batch when you hit that specified number of errors. ten is the default, and yes it counts πŸ‘€
  • --allowEmptyPipe[=false] β€” don't fail when the piped input (stdin) is empty. be gentle with it 🧚
  • --cache[=false] β€” enable cached responses. memories, but for HTTP 🧠
  • --cacheBodyPaths=[] β€” cache should limit hashing of selected paths in the json body. empty indicates all values. all of them, no crumbs left πŸ“
  • --cacheTTL="60s" β€” cache time-to-live (TTL) as a duration, i.e. 60s, 2m. it expires, respectfully ⏳
  • -c, --compact[=false] β€” compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal. know the difference bestie ✨
  • --confirm[=false] β€” prompt for confirmation. consent check but for commands 🫢
  • --confirmText="" β€” custom confirmation text. make it say whatever you want πŸ’¬
  • --currentPage=0 β€” current page which should be returned. which page are we on, main character?
  • --customQueryParam=[] β€” add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. ur own little query param moment πŸŽ€
  • --debug[=false] β€” set very verbose log messages. it WILL overshare and that's the point πŸ’€
  • --delay="0ms" β€” delay after each request, i.e. 5ms, 1.2s. take a lil breather 🌸
  • --delayBefore="0ms" β€” delay before each request, i.e. 5ms, 1.2s. breather, but pre-game 🌈
  • --dry[=false] β€” dry run. don't send any data to the server. practice mode, zero consequences 😌
  • --dryFormat="markdown" β€” dry run output format. i.e. json, dump, markdown or curl. pick ur aesthetic πŸ’…
  • --examples[=false] β€” show examples for the current command. show me how it's done πŸ‘‘
  • --filter=[] β€” apply a client side filter to the response before returning it to the user. the bouncer at the door πŸšͺ
  • --flatten[=false] β€” flatten json output by replacing nested json properties with properties where their names are represented by dot notation. un-nest it, let it breathe πŸ¦‹
  • -f, --force[=false] β€” do not prompt for confirmation. ignored when using --confirm. it's a whole thing, don't ask 😭
  • -H, --header=[] β€” custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue". dress your request up πŸ’–
  • --includeAll[=false] β€” include all results by iterating through each page. every. single. page. πŸ—‚οΈ
  • -k, --insecure[=false] β€” allow insecure server connections when using SSL. risky behavior, do not recommend, be safe bestie πŸ”₯
  • -l, --logMessage="" β€” add custom message to the activity log. leave ur lil signature ✍️
  • --maxJobs=0 β€” maximum number of jobs. 0 = unlimited (use with caution!). and we mean caution, fr fr ⚠️
  • --noAccept[=false] β€” ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. got it? PUT and POST only πŸ‘€
  • --noCache[=false] β€” force disabling of cached responses (overwrites cache setting). over it πŸ’€
  • -M, --noColor[=false] β€” don't use colors when displaying log entries on the console. monochrome era πŸ–€
  • --noLog[=false] β€” disables the activity log for the current command. no receipts 🀫
  • --noProgress[=false] β€” disable progress bars. no little bars bouncing around πŸ™…
  • --noProxy[=false] β€” ignore the proxy settings. straight there, no middleman πŸš€
  • -n, --nullInput[=false] β€” don't read the input (stdin). useful if using in shell for/while loops. ur welcome, loop girlies πŸ”
  • -o, --output="table" β€” output format. i.e. table, json, csv, csvheader. choose ur formatting destiny ✨
  • --outputFile="" β€” save JSON output to file (after select/view). post-processing save πŸ’Ύ
  • --outputFileRaw="" β€” save raw response to file (before select/view). raw save, no filter πŸ«™
  • --outputTemplate="" β€” jsonnet template to apply to the output. template moment 🎨
  • -p, --pageSize=5 β€” maximum results per page. five at a time, cute lil handful πŸ“
  • --progress[=false] β€” show progress bar. this will also disable any other verbose output. trade-off, bestie βš–οΈ
  • --proxy="" β€” proxy setting. i.e. http://10.0.0.1:8080. the scenic route πŸ—ΊοΈ
  • -r, --raw[=false] β€” show raw response. this mode will force output=json and view=off. no edits, no filter, raw dogging the response 😭
  • --retries=3 β€” max number of attempts when a failed http call is encountered. three strikes but make it resilient πŸ’ͺ
  • --select=[] β€” comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. choose ur faves πŸ‘‘
  • --session="" β€” session configuration. ur whole identity rn πŸͺž
  • --sessionMode="" β€” override default session mode for a single command which would normally be disabled. exception arc 🌟
  • -P, --sessionPassword="" β€” override session password. shhh, don't tell 🀫
  • -U, --sessionUsername="" β€” override session username. i.e. peter or t1234/peter (with tenant). tenant included and everything 🏠
  • --silentExit[=false] β€” silent status codes do not affect the exit code. the quiet ones get a pass 🀐
  • --silentStatusCodes="" β€” status codes which will not print out an error message. no yelling for these ones πŸ“΅
  • --timeout="600s" β€” request timeout duration. i.e. 60s, 2m. it's been 600s by default, be patient πŸ•°οΈ
  • --totalPages=0 β€” total number of pages to get. how many pages we collecting πŸ“š
  • -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 vibe πŸ‘€
  • --withError[=false] β€” errors will be printed on stdout instead of stderr. redirect the drama πŸ“€
  • --withTotalElements[=false] β€” request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). yes, 10.13, noted πŸ“Œ
  • -t, --withTotalPages[=false] β€” request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. page count supremacy πŸ—ƒοΈ
  • --workers=1 β€” number of workers. one hardworking little worker by default 🐝

πŸ”₯ EXAMPLE πŸ”₯

like, actual examples, bestie β€” use them 🫢

$ c8y bulkoperations list
Get a list of bulk operations
$ c8y bulkoperations list --dateFrom -1d
Get a list of bulk operations created in the last 1 day
$ c8y bulkoperations list --status SCHEDULED --status EXECUTING
Get a list of bulk operations in the general status SCHEDULED or EXECUTING

🌈 SEE ALSO 🌈


ok that's the whole page, go forth and list ur bulk operations responsibly ✨

and that's a wrap, bestie πŸŽ€ this little gem is dated Jan 1980 and comes to you from the c8y(1) manual, volume 1, section 1 β€” mwah, love u, bye πŸ’‹πŸ’–

πŸ“¦ where this page comes from