openqa-client(1)

openqa-client1

Deprecated script for talking to an openqa server

Usage

openqa-client [OPTIONS] PATH

Options

--host HOST

Connect to specified host, defaults to localhost

--params FILE

Load get/post parameters from a json file. For example

{
"FLAVOR" : "DVD",
"BUILD" : "42",
"ARCH" : "i586",
"DISTRI" : "opensuse",
"VERSION" : "26", }

--apibase

Set API base URL component, default: '/api/v1'

--json-output

Output JSON instead of Perl structures.

--yaml-output

Output YAML instead of Perl structures.

accept (json|yaml)

Send Accept header to explicitly tell the API what format is accepted

Returning YAML is deprecated, and currently only one endpoint (job_templates_scheduling) is able to return YAML anyway.

By default, "Accept: */*" is sent.

--verbose, -v

Be verbose in output.

--apikey KEY, --apisecret SECRET

Specify api key and secret to use, overrides use of config file ~/.config/openqa/client.conf

--json-data

Send JSON data; expected by certain routes

For example: jobs/639172 put --json-data '{"group_id": 1}'

--form

Send form data (application/x-www-form-urlencoded) instead of appending supplied parameters as URL query; expected by certain routes

This is for instance used to post job templates, e.g.:

job_templates_scheduling/1 post --form schema=JobTemplates-01.yaml preview=0 template="$(cat foo.yaml)"

To create nested forms use dotted syntax, e.g.:

jobs/1/artefact post --form file.file=bar file.filename=bar.log

--help, -h

print help

Archive mode

--archive, -a DIRECTORY

Archive mode: Download assets and test results from a job to DIRECTORY.

--with-thumbnails

Archive mode: Include thumbnails

--asset-size-limit LIMIT

Archive mode: Download assets that do not exceed the specified limit in bytes The default limit is 200 MB.

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

From openqa-client 4.6.1732034221.ae34b08ff-2 in Debian 13 (Trixie). Parsed by carta from the page's man source.