NAME

evqueue_api - evQueue utilities

SYNOPSIS

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

DESCRIPTION

Utility to query evQueue API from command line. Can be used to connect to the evQueue core through TCP or UNIX sockets.

Options, group and action MUST be passed before other arguments. Arguments expected after action are expected to be API command parameters only.

OPTIONS

--connect connection_string

Connect to server identified by connection_string. Two formats are accepted :

tcp socket: tcp://<hostname>[:<port>]

unix socket: unix://<path>

--user <username>

Use this username if authentication is required by daemon.

--password <password>

Use this password if authentication is required by daemon.

--noformat

Returns raw XML instead of indented XML.

--<group>

The API command group, for example --tasks to query task API.

--<action>

The action to request to API command group, for example --get to query an element.

EXAMPLES

evqueue_api --task --get --id 1
Retrieve task information from API.

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

http://www.evqueue.net/