plucky (1) openqa-client.1.gz

NAME

       openqa-client - deprecated script for talking to an openQA server

SYNOPSIS

       This script is deprecated, use openqa-cli instead

       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.

SYNOPSIS

       Interact with the openQA API by specified route entry points and optionally operations, defaults to the
       'get' operation, i.e. just reading out the data without changing it. See the help on the openQA instance
       you want to access for available API routes.

       Common top level entry points: jobs, workers, isos.

       client --host openqa.example.com jobs
           List all jobs. Caution: this will take a very long time or even timeout on big productive instances.

       client --host openqa.example.com jobs groupid=135 distri=caasp version=3.0 latest=1
           List all jobs matching the specified search criteria.

       client --host openqa.example.com jobs/overview groupid=135 distri=caasp version=3.0
           List the latest jobs for the latest build in the given scenario.  In contrast to the route above,
           this will limit the results to the latest build in the same way the test result overview in the web
           UI does.

       client --host openqa.example.com jobs/1
           Show details of job nr. 1.

       client --host openqa.example.com jobs/1 delete
           Delete job nr. 1 (permissions read from config file).

       client --host openqa.example.com isos post ISO=bar.iso DISTRI=my-distri FLAVOR=my-flavor ARCH=my-arch
       VERSION=42 BUILD=1234
           Trigger jobs on iso bar.iso matching test suite blah.

       client --archive /path/to/directory --asset-size-limit 1048576000 --with-thumbnails --host
       openqa.opensuse.org jobs/42
           Download all assets and test logs and images from job 42 with asset limit of 1GB to
           /path/to/directory.