EVQUEUE_API(8)

📦 version 2.1, in ubuntu jammy, ubuntu noble

💖 EVQUEUE_API — evQueue utilities 💖

okay bestie, welcome to the <rainbow>evqueue_api</rainbow> page, part of the evQueue manual. yes we're in section 8, yes it's a real one, and yes it's gonna be fun. sit down, hydrate, let's go 🫶

✨ SYNOPSIS ✨

evqueue_api [ OPTIONS ] --<group> --<action> [--<parameter name>
<parameter value>]*

🌸 DESCRIPTION 🌸

so basically <pink>evqueue_api</pink> is a cute little utility that lets you query the evQueue API straight from the command line. no browser, no vibes-destroying GUI, just you and your terminal. 💅

and the way it connects?? flexible. it can hook up to the evQueue core through either TCP or UNIX sockets — pick your fighter. 🦋

⚠️ okay this part is not optional, bestie. Options, group and action MUST be passed before other arguments. like, the order is the whole thing. no cap.

and everything you pass after the action? that's expected to be API command parameters only. nothing else. that's the assignment. 📝

🎀 OPTIONS 🎀

  • --connect connection_string — connect to the server identified by connection_string. and guess what, two formats are accepted, slay:
    • tcp socket: tcp://<hostname>[:<port>]
    • unix socket: unix://<path>
  • --user username — use this username if the daemon is asking for authentication. 🔐
  • --password password — use this password if the daemon is asking for authentication. yes, alongside the user. the duo. 👑
  • --noformat — returns raw XML instead of indented XML. so if you like your XML squished and unbothered, this one's for you. 🙈
  • --<group> — the API command group. for example --tasks to query the task API. ✨
  • --<action> — the action to request from the API command group. for example --get to query an element. 🔥

🌈 EXAMPLES 🌈

example one: get a task, get the tea 🍓

evqueue_api --task --get --id 1

Retrieve task information from API.

example two: UNIX socket + auth + workflows, the full combo meal 🧚

evqueue_api --connect unix:///var/run/evqueue.socket --user admin
--password admin --workflows --list

Connect to evqueue engine using UNIX socket and authentication. Request the list of available workflows.

💜 SEE ALSO 💜

and that's the page, bestie!! 🎀 go query something iconic. this was the evQueue utilities page, dated 2016-07-11, living in EVQUEUE_API(8). mwah 💋✨👑

📦 where this page comes from